Docs: fix wrong max-depth example (fixes #11991) #12358
Merged
Conversation
|
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. |
Signed-off-by: Gabriel R. Sezefredo <g@briel.dev>
|
LGTM. Thank you for contributing to ESLint! |
84467c0
into
eslint:master
16 checks passed
16 checks passed
continuous-integration (Test on Node.js 12 (Windows))
Test on Node.js 12 (Windows) succeeded
Details
This was referenced Oct 8, 2019
This was referenced Nov 9, 2019
This was referenced Mar 11, 2020
This was referenced Mar 26, 2020
This was referenced Apr 3, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
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-depthin 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?