docs: Clarify no-div-regex rule docs (#17051)

* fix: Clarify `no-div-regex` rule docs * Update opening section Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> --------- Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
eslint · Apr 4, 2023 · a3aa6f5 · a3aa6f5
1 parent 0dde022
commit a3aa6f5
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/docs/src/rules/no-div-regex.md b/docs/src/rules/no-div-regex.md
@@ -8,15 +8,15 @@ related_rules:
 
 
 
-Require regex literals to escape division operators.
+Characters `/=` at the beginning of a regular expression literal can be confused with a division assignment operator.
 
 ```js
 function bar() { return /=foo/; }
 ```
 
 ## Rule Details
 
-This is used to disambiguate the division operator to not confuse users.
+This rule forbids equal signs (`=`) after the slash (`/`) at the beginning of a regular expression literal, because the characters `/=` can be confused with a division assignment operator.
 
 Examples of **incorrect** code for this rule:
 

diff --git a/lib/rules/no-div-regex.js b/lib/rules/no-div-regex.js
@@ -15,7 +15,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "Disallow division operators explicitly at the beginning of regular expressions",
+            description: "Disallow equal signs explicitly at the beginning of regular expressions",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-div-regex"
         },