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: Add missing quotes #13714

Merged
merged 1 commit into from Sep 24, 2020
Merged

Docs: Add missing quotes #13714

merged 1 commit into from Sep 24, 2020

Conversation

luciopaiva
Copy link
Contributor

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an 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 it was, one of the examples in the lines-between-class-members rule article was not a valid JSON because it was missing quotes.

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

Nothing. This is a tiny contribution, easy to verify.

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Sep 24, 2020
@luciopaiva luciopaiva changed the title Add missing quotes on doc article Docs: add missing quotes on doc article Sep 24, 2020
As it was, the example was not a valid JSON.
@luciopaiva luciopaiva changed the title Docs: add missing quotes on doc article Docs: Add missing quotes on doc article Sep 24, 2020
@luciopaiva luciopaiva changed the title Docs: Add missing quotes on doc article Docs: Add missing quotes Sep 24, 2020
@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 24, 2020
@mdjermanovic
Copy link
Member

Hi @luciopaiva, thanks for the PR!

Quotes are not necessary in configuration comments (as in this Demo), but we do aim to have them in the examples, so this is a good change for consistency with other documents.

Copy link
Member

@mdjermanovic mdjermanovic 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!

@luciopaiva
Copy link
Contributor Author

luciopaiva commented Sep 24, 2020

Quotes are not necessary in configuration comments

Oh, thanks for pointing that out.

I pasted it directly from the docs into my .eslintrc.json file and that's why I noticed the lack of quotes. The consistency argument is good, though. Thanks for taking the time to review 👍

@nzakas nzakas merged commit 51674a4 into eslint:master Sep 24, 2020
@luciopaiva luciopaiva deleted the patch-1 branch September 26, 2020 18:46
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Mar 24, 2021
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Mar 24, 2021
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