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 examples in object-curly-newline #13605

Merged

Conversation

soobing
Copy link
Contributor

@soobing soobing commented Aug 22, 2020

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)

The example of correct/incorrect really helpful to user.
So if not match between these two, can give confusion.
When I was reading in object-curly-newline docs there was not matching example in case of consistent.

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

I'm not sure that I correctly added example in correct case. So I ask to review to focus on pair between correct case and incorrect case.

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Aug 22, 2020
@soobing soobing force-pushed the docs/object-curly-newline-consistent branch from a3567ba to d9c6315 Compare August 22, 2020 05:34
@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 Aug 22, 2020
@mdjermanovic
Copy link
Member

Hi @soobing, thanks for the PR!

Makes sense to me, marked as accepted. It's usually good to have matching examples in "correct" and "incorrect" sections, though it isn't always possible.

Also, it seems we had some wrong examples.

docs/rules/object-curly-newline.md Outdated Show resolved Hide resolved
docs/rules/object-curly-newline.md Outdated Show resolved Hide resolved
docs/rules/object-curly-newline.md Outdated Show resolved Hide resolved
docs/rules/object-curly-newline.md Outdated Show resolved Hide resolved
@mdjermanovic mdjermanovic changed the title docs: consistent's example in object-curly-newline is do not match between correct and incorrect. Docs: fix examples in object-curly-newline Aug 22, 2020
@soobing
Copy link
Contributor Author

soobing commented Aug 24, 2020

@mdjermanovic
Oh thanks for accept. I didn't know that the demo, so there are alot that I added examples in incorrect case even though it's correct 😃. I will try again today and ask review.

@mdjermanovic
Copy link
Member

Looks great!

Can you please fix the linting error: it seems there's a tab at the beginning of line 338.

You can check this locally with npm run lint

@soobing
Copy link
Contributor Author

soobing commented Aug 27, 2020

@mdjermanovic
Thank you I changed tab to space 👍🏻😃

Copy link
Member

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

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!

@mdjermanovic mdjermanovic merged commit 483bf7f into eslint:master Aug 27, 2020
@mdjermanovic
Copy link
Member

Thanks for contributing!

@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Mar 18, 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 18, 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