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 'When Not To Use' in prefer-named-capture-group (refs #14959) #14969

Merged
merged 1 commit into from Aug 24, 2021

Conversation

mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented Aug 23, 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:

refs #14959, fixes the "When Not To Use It" section in prefer-named-capture-group docs.

This rule must be disabled "if you are targeting ECMAScript 2017 and/or older environments" because it enforces the use of a syntax that isn't supported in those environments, but the wording "you can disable this rule" doesn't clearly imply that.

What changes did you make? (Give an overview)

fixed "you can disable this rule" -> "you should not use this rule"

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

@mdjermanovic mdjermanovic added rule Relates to ESLint's core rules documentation Relates to ESLint's documentation accepted There is consensus among the team that this change meets the criteria for inclusion labels Aug 23, 2021
Copy link
Contributor

@snitin315 snitin315 left a comment

LGTM

nzakas
nzakas approved these changes Aug 24, 2021
@nzakas nzakas merged commit b301069 into master Aug 24, 2021
13 checks passed
@nzakas nzakas deleted the prefernamedcapturegroup-whennottouse branch Aug 24, 2021
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Feb 21, 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 21, 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 rule Relates to ESLint's core rules
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants