docs: Improve id-denylist documentation #16223
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eslint-github-bot
bot
added
the
triage
|
Hi @frankie303!, thanks for the Pull Request The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.
To Fix: You can fix this problem by running Read more about contributing to ESLint here |
|
|
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
frankie303
force-pushed
the
improve-id-denylist-doc
branch
from
85f39af
to
ae77177
Compare
frankie303
changed the title
snitin315
added
evaluating
I didn't see that issue before and I would definitely suggest to merge one of the PRs. It's clear that this rule causes some confusion for developers. Thanks! |
nzakas
reviewed
Aug 26, 2022
docs/src/rules/id-denylist.md
Outdated
| @@ -38,6 +38,8 @@ For example, to restrict the use of common generic identifiers: | |||
| } | |||
| ``` | |||
|
|
|||
| **Note:** First element of the array specifies the severity of the rule and it should be one of the following: 0 = "off", 1 = "warn", 2 = "error". Rest are the disallowed identifiers you want to add. | |||
There was a problem hiding this comment.
Instead of restating the values for severity, can we just link to the section on configuring rules in the docs?
There was a problem hiding this comment.
Hi Nicholas, thanks for the feedback! I updated it. Please let me know if I can do further improvement in the sentence.
nzakas
reviewed
Aug 29, 2022
docs/src/rules/id-denylist.md
Outdated
| @@ -38,7 +38,7 @@ For example, to restrict the use of common generic identifiers: | |||
| } | |||
| ``` | |||
|
|
|||
| **Note:** First element of the array specifies the severity of the rule and it should be one of the following: 0 = "off", 1 = "warn", 2 = "error". Rest are the disallowed identifiers you want to add. | |||
| **Note:** First element of the array is for [rules configuration](https://eslint.org/docs/latest/user-guide/configuring/rules). Rest are the disallowed identifiers you want to add. | |||
There was a problem hiding this comment.
Suggested change
| **Note:** First element of the array is for [rules configuration](https://eslint.org/docs/latest/user-guide/configuring/rules). Rest are the disallowed identifiers you want to add. | |
| **Note:** The first element of the array is for the rule severity (see [configuring rules](/docs/latest/user-guide/configuring/rules). The other elements in the array are the identifiers that you want to disallow. |
crapStone
pushed a commit
to Calciumdibromid/CaBr2
that referenced
this pull request
Sep 22, 2022
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | patch | [`8.23.0` -> `8.23.1`](https://renovatebot.com/diffs/npm/eslint/8.23.0/8.23.1) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.23.1`](https://github.com/eslint/eslint/releases/tag/v8.23.1) [Compare Source](eslint/eslint@v8.23.0...v8.23.1) #### Bug Fixes - [`b719893`](eslint/eslint@b719893) fix: Upgrade eslintrc to stop redefining plugins ([#​16297](eslint/eslint#16297)) (Brandon Mills) - [`734b54e`](eslint/eslint@734b54e) fix: improve autofix for the `prefer-const` rule ([#​16292](eslint/eslint#16292)) (Nitin Kumar) - [`6a923ff`](eslint/eslint@6a923ff) fix: Ensure that glob patterns are normalized ([#​16287](eslint/eslint#16287)) (Nicholas C. Zakas) - [`c6900f8`](eslint/eslint@c6900f8) fix: Ensure globbing doesn't include subdirectories ([#​16272](eslint/eslint#16272)) (Nicholas C. Zakas) #### Documentation - [`16cba3f`](eslint/eslint@16cba3f) docs: fix mobile double tap issue ([#​16293](eslint/eslint#16293)) (Sam Chen) - [`e098b5f`](eslint/eslint@e098b5f) docs: keyboard control to search results ([#​16222](eslint/eslint#16222)) (Shanmughapriyan S) - [`1b5b2a7`](eslint/eslint@1b5b2a7) docs: add Consolas font and prioritize resource loading ([#​16225](eslint/eslint#16225)) (Amaresh S M) - [`1ae8236`](eslint/eslint@1ae8236) docs: copy & use main package version in docs on release ([#​16252](eslint/eslint#16252)) (Jugal Thakkar) - [`279f0af`](eslint/eslint@279f0af) docs: Improve id-denylist documentation ([#​16223](eslint/eslint#16223)) (Mert Ciflikli) #### Chores - [`38e8171`](eslint/eslint@38e8171) perf: migrate rbTree to js-sdsl ([#​16267](eslint/eslint#16267)) (Zilong Yao) - [`1c388fb`](eslint/eslint@1c388fb) chore: switch nyc to c8 ([#​16263](eslint/eslint#16263)) (唯然) - [`67db10c`](eslint/eslint@67db10c) chore: enable linting `.eleventy.js` again ([#​16274](eslint/eslint#16274)) (Milos Djermanovic) - [`42bfbd7`](eslint/eslint@42bfbd7) chore: fix `npm run perf` crashes ([#​16258](eslint/eslint#16258)) (唯然) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xOTQuNSIsInVwZGF0ZWRJblZlciI6IjMyLjE5NC41In0=--> Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1543 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
eslint-github-bot
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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)
I added a small note to
id-denylistdocumentation to clarify the usage of configuration array. It took me some time to realise the first element of the array specifies the severity of the rule even tough it also seems like one of the disallowed identifiers. So this small addition addresses the confusion. Also you can see this issue which mentioned the same confusion.Is there anything you'd like reviewers to focus on?