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: Make clear how rule options are overridden (fixes #14962) #14976

Merged
merged 2 commits into from Aug 31, 2021
Merged

Docs: Make clear how rule options are overridden (fixes #14962) #14976

merged 2 commits into from Aug 31, 2021

Conversation

tzeikob
Copy link
Contributor

@tzeikob tzeikob commented Aug 25, 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 autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

I updated the documentation in Extending Configuration Files by adding another example overriding a rule in order to make clear to the reader how rules with options given as object are overridden.

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

No

@eslint-github-bot eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Aug 25, 2021
@snitin315
Copy link
Contributor

snitin315 commented Aug 25, 2021

@tzeikob Can you accept CLA?

@tzeikob
Copy link
Contributor Author

tzeikob commented Aug 25, 2021

@snitin315 done!

nzakas
nzakas approved these changes Aug 26, 2021
Copy link
Member

@nzakas nzakas left a comment

LGTM. Thanks.

@nzakas nzakas added accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation and removed triage An ESLint team member will look at this issue soon labels Aug 26, 2021
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Aug 30, 2021

CLA Signed

The committers are authorized under a signed CLA.

nzakas
nzakas approved these changes Aug 31, 2021
@brianwarner brianwarner reopened this Aug 31, 2021
@mdjermanovic mdjermanovic linked an issue Aug 31, 2021 that may be closed by this pull request
Copy link
Member

@mdjermanovic mdjermanovic left a comment

LGTM, thanks for contributing!

@mdjermanovic mdjermanovic merged commit 88b4e3d into eslint:master Aug 31, 2021
22 checks passed
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Feb 28, 2022
@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 Feb 28, 2022
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation about overriding rules
6 participants