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.

Sign up for GitHub

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

Jump to bottom

docs: Improve id-denylist documentation #16223

Merged
merged 3 commits into from Aug 30, 2022
Merged

docs: Improve id-denylist documentation #16223

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae77177
docs: Improve id-denylist documentation
frankie303 Aug 21, 2022
3bf0c20
docs: add configuring rules link to id-denylist
frankie303 Aug 26, 2022
c426730
docs: review changes
frankie303 Aug 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/src/rules/id-denylist.md
View file
Open in desktop
Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

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

Instead of restating the values for severity, can we just link to the section on configuring rules in the docs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi Nicholas, thanks for the feedback! I updated it. Please let me know if I can do further improvement in the sentence.


Examples of **incorrect** code for this rule with sample `"data", "callback"` restricted identifiers:

::: incorrect
Expand Down