Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: fix wrong max-depth example (fixes #11991) #12358

Merged
merged 1 commit into from Oct 8, 2019

Conversation

gabrieldrs
Copy link
Contributor

What is the purpose of this pull request? (put an "X" next to item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)
As mentioned by @imai0917 on #11991, the example given for max-depth in the documentation doesn't trigger the rule, so this updates the example with one that does.

Is there anything you'd like reviewers to focus on?

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Oct 1, 2019
Copy link
Member

@kaicataldo kaicataldo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for contributing! For clarity's sake, can we also update the correct example? I think the addition of the function expression makes it less clear why this is correct versus the example you updated. I think it would be best to use the same code sample for the updated incorrect example but with the most nested (the one labeled "Nested 5 deep") removed.

@kaicataldo kaicataldo added accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation and removed triage An ESLint team member will look at this issue soon labels Oct 2, 2019
Signed-off-by: Gabriel R. Sezefredo <g@briel.dev>
Copy link
Member

@kaicataldo kaicataldo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thank you for contributing to ESLint!

@kaicataldo kaicataldo merged commit 84467c0 into eslint:master Oct 8, 2019
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Apr 7, 2020
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Apr 7, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants