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: Update sort-keys options properties count #18025

Merged
merged 1 commit into from Jan 24, 2024

Conversation

lb-
Copy link
Contributor

@lb- lb- commented Jan 23, 2024

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
[ ] Other, please explain:

What changes did you make? (Give an overview)

Currently the options listing for sort-keys says there are 3 properties, however this is not accurate. I have updated this to be generic so it does not have to be modified if new properties are added.

It appears that the 4th property allowLineSeparatedGroups was added via #16138 & relates to #12759

I could not see any open PRs or issues for this.

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

N/A

@lb- lb- requested a review from a team as a code owner January 23, 2024 23:14
Copy link

netlify bot commented Jan 23, 2024

Deploy Preview for docs-eslint canceled.

Name Link
🔨 Latest commit c5dc86b
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/65b0c08717a9ea00080b74da

@eslint-github-bot
Copy link

Hi @lb-!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.
  • The first letter of the tag should be in lowercase

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

Copy link

linux-foundation-easycla bot commented Jan 23, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: lb- / name: LB (Ben Johnston) (c5dc86b)

Copy link
Member

@Rec0iL99 Rec0iL99 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @lb-. Could you please sign the CLA before this gets merged?

Please follow the PR heading formatting instructions from the bot too (#18025 (comment))

@lb- lb- changed the title Update sort-keys documentation to be generic about the count of opts docs: Update sort-keys options description to avoid incorrect property count Jan 24, 2024
@eslint-github-bot
Copy link

Hi @lb-!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

  • The length of the commit message must be less than or equal to 72

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

@eslint-github-bot
Copy link

Hi @lb-!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

  • The length of the commit message must be less than or equal to 72

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

@lb- lb- changed the title docs: Update sort-keys options description to avoid incorrect property count Docs: Update sort-keys options description to avoid incorrect property count Jan 24, 2024
@eslint-github-bot
Copy link

Hi @lb-!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.
  • The first letter of the tag should be in lowercase
  • The length of the commit message must be less than or equal to 72

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

@lb- lb- changed the title Docs: Update sort-keys options description to avoid incorrect property count docs: Update sort-keys options properties count Jan 24, 2024
@eslint-github-bot eslint-github-bot bot added the documentation Relates to ESLint's documentation label Jan 24, 2024
The current count is incorrect (3), as there are four items.
Avoid needing to update this with making the text more generic.
@lb-
Copy link
Contributor Author

lb- commented Jan 24, 2024

OK I think I am good now. Commit message is good & CLA done.

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 e6eebca into eslint:main Jan 24, 2024
18 checks passed
@lb- lb- deleted the docs/sort-keys-options branch January 24, 2024 08:38
@lb-
Copy link
Contributor Author

lb- commented Jan 24, 2024

Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to ESLint's documentation
Projects
Status: Complete
Development

Successfully merging this pull request may close these issues.

None yet

3 participants