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

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-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Sep 7, 2019
@mdjermanovic
Copy link
Member Author

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
Copy link
Member Author

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

Copy link
Member

@platinumazure platinumazure left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@mdjermanovic mdjermanovic added accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation rule Relates to ESLint's core rules and removed triage An ESLint team member will look at this issue soon labels Sep 8, 2019
@mysticatea mysticatea merged commit d52328f into master Sep 13, 2019
@mysticatea mysticatea deleted the nosequences-with branch September 13, 2019 05:11
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Mar 12, 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 Mar 12, 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 rule Relates to ESLint's core rules
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants