From ae77177197e571a2f28ce7fbf59bded7be9db8d3 Mon Sep 17 00:00:00 2001 From: Mert Ciflikli Date: Sun, 21 Aug 2022 17:33:45 +0200 Subject: [PATCH 1/3] docs: Improve id-denylist documentation --- docs/src/rules/id-denylist.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/src/rules/id-denylist.md b/docs/src/rules/id-denylist.md index 3a9f61f5c8c..a1caa9db23c 100644 --- a/docs/src/rules/id-denylist.md +++ b/docs/src/rules/id-denylist.md @@ -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. + Examples of **incorrect** code for this rule with sample `"data", "callback"` restricted identifiers: ::: incorrect From 3bf0c20eb1fe42834bc28eeb979c5e2f0a8f3864 Mon Sep 17 00:00:00 2001 From: Mert Ciflikli Date: Fri, 26 Aug 2022 21:10:41 +0200 Subject: [PATCH 2/3] docs: add configuring rules link to id-denylist --- docs/src/rules/id-denylist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/rules/id-denylist.md b/docs/src/rules/id-denylist.md index a1caa9db23c..7e38c38b9a1 100644 --- a/docs/src/rules/id-denylist.md +++ b/docs/src/rules/id-denylist.md @@ -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. Examples of **incorrect** code for this rule with sample `"data", "callback"` restricted identifiers: From c42673088ba9fb069f003a20adf414aa0963698f Mon Sep 17 00:00:00 2001 From: Mert Ciflikli Date: Tue, 30 Aug 2022 07:38:22 +0200 Subject: [PATCH 3/3] docs: review changes --- docs/src/rules/id-denylist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/rules/id-denylist.md b/docs/src/rules/id-denylist.md index 7e38c38b9a1..271d2a38e84 100644 --- a/docs/src/rules/id-denylist.md +++ b/docs/src/rules/id-denylist.md @@ -38,7 +38,7 @@ For example, to restrict the use of common generic identifiers: } ``` -**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. Examples of **incorrect** code for this rule with sample `"data", "callback"` restricted identifiers: