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 eslint bot added the triage label Aug 22, 2020
@soobing soobing force-pushed the soobing:docs/object-curly-newline-consistent branch from a3567ba to d9c6315 Aug 22, 2020
@mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented Aug 22, 2020

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 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.

@soobing soobing requested a review from mdjermanovic Aug 24, 2020
@mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented Aug 26, 2020

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 soobing commented Aug 27, 2020

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

Copy link
Member

@kaicataldo kaicataldo left a comment

LGTM, thanks!

Copy link
Member

@mdjermanovic mdjermanovic left a comment

LGTM, thanks!

@mdjermanovic mdjermanovic merged commit 483bf7f into eslint:master Aug 27, 2020
12 checks passed
12 checks passed
Verify Files
Details
Test (ubuntu-latest, 14.x)
Details
Test (ubuntu-latest, 13.x)
Details
Test (ubuntu-latest, 12.x)
Details
Test (ubuntu-latest, 10.x)
Details
Test (ubuntu-latest, 10.12.0)
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
licence/cla Contributor License Agreement is signed.
Details
release-monitor No patch release is pending
Details
@mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented Aug 27, 2020

Thanks for contributing!

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

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