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 no-sequences `with` examples #12239

Merged
merged 2 commits into from Sep 13, 2019
Merged

Docs: fix no-sequences `with` examples #12239

merged 2 commits into from Sep 13, 2019

Conversation

@mdjermanovic
Copy link
Member

mdjermanovic commented Sep 7, 2019

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

[X] Documentation update

There is an unusual commented // with example in no-sequences documentation.

It could have something with linting documentation examples (#2271) in the past?

What changes did you make? (Give an overview)

Removed both with examples from this document.

The example can be uncommented now and npm test will work well. Nevertheless, I think that with is not of particular importance for this rule, there are no examples with with in other rules (apart from how to disable it in no-with and no-restricted-syntax) so I guess it's better to avoid it in examples?

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

If it isn't okay to remove these lines, I'll revert it and just uncomment the example.

@eslint eslint bot added the triage label Sep 7, 2019
@mdjermanovic

This comment has been minimized.

Copy link
Member Author

mdjermanovic commented Sep 7, 2019

Actually I understand now why the with example is important for this rule - to show that it must be parenthesised twice. Maybe better to put the example back in the docs and just remove //?

@mdjermanovic

This comment has been minimized.

Copy link
Member Author

mdjermanovic commented Sep 7, 2019

Done. All lines are still there, the example in question is just uncommented.

Copy link
Member

platinumazure left a comment

LGTM, thanks!

@mysticatea mysticatea merged commit d52328f into master Sep 13, 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 PR title follows commit message guidelines
Details
continuous-integration Build #20190907.6 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
@mysticatea mysticatea deleted the nosequences-with branch Sep 13, 2019
@eslint eslint bot locked and limited conversation to collaborators Mar 12, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

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