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

gabrieldrs commented Oct 1, 2019

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 eslint bot added the triage label Oct 1, 2019
Copy link
Member

kaicataldo left a comment

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>
@gabrieldrs gabrieldrs force-pushed the gabrieldrs:doc_fix branch from f4b3378 to 38644d3 Oct 2, 2019
@gabrieldrs gabrieldrs requested a review from kaicataldo Oct 2, 2019
Copy link
Member

kaicataldo left a comment

LGTM. Thank you for contributing to ESLint!

@kaicataldo kaicataldo merged commit 84467c0 into eslint:master Oct 8, 2019
16 checks passed
16 checks passed
Verify Files
Details
Test (ubuntu-latest, 8.x)
Details
Test (ubuntu-latest, 10.x)
Details
Test (ubuntu-latest, 12.x)
Details
Test (windows-latest, 12.x)
Details
Test (macOS-latest, 12.x)
Details
Browser Test
Details
commit-message Commit message follows guidelines
Details
continuous-integration Build #20191002.3 succeeded
Details
continuous-integration (Test on Node.js 10 (Linux)) Test on Node.js 10 (Linux) succeeded
Details
continuous-integration (Test on Node.js 12 (Linux)) Test on Node.js 12 (Linux) succeeded
Details
continuous-integration (Test on Node.js 12 (Windows)) Test on Node.js 12 (Windows) succeeded
Details
continuous-integration (Test on Node.js 12 (macOS)) Test on Node.js 12 (macOS) succeeded
Details
continuous-integration (Test on Node.js 8 (Linux)) Test on Node.js 8 (Linux) succeeded
Details
licence/cla Contributor License Agreement is signed.
Details
release-monitor No patch release is pending
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.