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: consistency changes #15404

Merged
merged 4 commits into from Dec 28, 2021
Merged

docs: consistency changes #15404

merged 4 commits into from Dec 28, 2021

Conversation

BBosman
Copy link
Contributor

@BBosman BBosman commented Dec 8, 2021

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 autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[X] Other, please explain:

What changes did you make? (Give an overview)

I've made a bunch of consistency changes to the rules documentation, including:

  • Fixed header casing (i.e. options -> Options)
  • Fixed header levels (i.e. ## allow -> ### allow)
  • Removed duplicate headers (i.e. multiple ## Rule Details headers)
  • Made all inter-rule links internal links if they weren't already (i.e. [object-shorthand](https://eslint.org/docs/rules/object-shorthand) -> [object-shorthand](object-shorthand.md))
  • Made unordered list style consistent (i.e. - -> * ). Almost everywhere * was already used so fixed the few places it wasn't. I also added an entry to markdownlint.yml to ensure future consistency. This also resulted in a couple of changes outside of the rules directory.
  • Made the order of sections consistent. The order is now always "Rule Details", "Options", "Environments", "Examples", "Known Limitations", "When Not To Use It", "Related Rules", "Compatibility", "Further Reading". Especially those last three had quite a few permutations. The order is arbitrary, but made sense to me.
  • Added a test to Makefile.js to validate those header names and their order
  • Some typo fixes and similar minor changes.

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

This is my first PR to eslint and I think I followed all guidelines, but I'm happy to make improvements to the PR if needed.

@eslint-github-bot eslint-github-bot bot added the triage label Dec 8, 2021
@linux-foundation-easycla
Copy link

@linux-foundation-easycla linux-foundation-easycla bot commented Dec 8, 2021

CLA Signed

The committers are authorized under a signed CLA.

@eslint-github-bot eslint-github-bot bot added the documentation label Dec 8, 2021
Copy link
Member

@aladdin-add aladdin-add left a comment

LGTM, just a minor suggestion.

.github/ISSUE_TEMPLATE/NEW_SYNTAX.md Outdated Show resolved Hide resolved
Copy link
Member

@aladdin-add aladdin-add left a comment

LGTM, thanks!

Copy link
Member

@nzakas nzakas left a comment

Thanks, this is some nice work. Just a handful of changes I don’t think we can make but overall looks good.

.github/ISSUE_TEMPLATE/NEW_SYNTAX.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
Makefile.js Outdated Show resolved Hide resolved
@BBosman
Copy link
Contributor Author

@BBosman BBosman commented Dec 17, 2021

@nzakas, I think I addressed all your comments.

Makefile.js Show resolved Hide resolved
@mdjermanovic mdjermanovic added accepted and removed triage labels Dec 21, 2021
Copy link
Member

@mdjermanovic mdjermanovic left a comment

Very nice work, thanks! I left only two small suggestions.

docs/rules/no-negated-in-lhs.md Outdated Show resolved Hide resolved
docs/rules/accessor-pairs.md Outdated Show resolved Hide resolved
Copy link
Member

@mdjermanovic mdjermanovic left a comment

LGTM, thanks!

Copy link
Contributor

@snitin315 snitin315 left a comment

Nice enhancement. Thank you for your contribution.

@aladdin-add aladdin-add requested a review from nzakas Dec 23, 2021
nzakas
nzakas approved these changes Dec 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants