docs: update description of no-param-reassign (#19220)

lumirlumir · web-flow · commit b607ae64913c · 2024-12-06T12:56:05.000+01:00
* docs: add missing backticks to `no-param-reassign.md`

* wip

* wip
diff --git a/docs/src/_data/rules_meta.json b/docs/src/_data/rules_meta.json
@@ -1760,7 +1760,7 @@
     "no-param-reassign": {
         "type": "suggestion",
         "docs": {
-            "description": "Disallow reassigning `function` parameters",
+            "description": "Disallow reassigning function parameters",
             "recommended": false,
             "url": "https://eslint.org/docs/latest/rules/no-param-reassign"
         }
diff --git a/docs/src/rules/no-param-reassign.md b/docs/src/rules/no-param-reassign.md
@@ -6,7 +6,7 @@ further_reading:
 ---
 
 
-Assignment to variables declared as function parameters can be misleading and lead to confusing behavior, as modifying function parameters will also mutate the `arguments` object when not in strict mode (see [When Not To Use It](#when-not-to-use-it) below). Often, assignment to function parameters is unintended and indicative of a mistake or programmer error.
+Assignment to variables declared as function parameters can be misleading and lead to confusing behavior, as modifying function parameters will also mutate the `arguments` object when not in `strict` mode (see [When Not To Use It](#when-not-to-use-it) below). Often, assignment to function parameters is unintended and indicative of a mistake or programmer error.
 
 This rule can be also configured to fail when function parameters are modified. Side effects on parameters can cause counter-intuitive execution flow and make errors difficult to track down.
 
@@ -184,4 +184,4 @@ var foo = function(barBaz) {
 
 If you want to allow assignment to function parameters, then you can safely disable this rule.
 
-Strict mode code doesn't sync indices of the arguments object with each parameter binding. Therefore, this rule is not necessary to protect against arguments object mutation in ESM modules or other strict mode functions.
+`strict` mode code doesn't sync indices of the arguments object with each parameter binding. Therefore, this rule is not necessary to protect against arguments object mutation in ESM modules or other `strict` mode functions.
diff --git a/lib/rules/no-param-reassign.js b/lib/rules/no-param-reassign.js
@@ -1,5 +1,5 @@
 /**
- * @fileoverview Disallow reassignment of function parameters.
+ * @fileoverview Disallow reassigning function parameters.
  * @author Nat Burns
  */
 "use strict";
@@ -16,7 +16,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "Disallow reassigning `function` parameters",
+            description: "Disallow reassigning function parameters",
             recommended: false,
             url: "https://eslint.org/docs/latest/rules/no-param-reassign"
         },

Original file line number	Diff line number	Diff line change
`@@ -1760,7 +1760,7 @@`
`1760`	`1760`	`"no-param-reassign": {`
`1761`	`1761`	`"type": "suggestion",`
`1762`	`1762`	`"docs": {`
`1763`		- "description": "Disallow reassigning `function` parameters",
	`1763`	`+ "description": "Disallow reassigning function parameters",`
`1764`	`1764`	`"recommended": false,`
`1765`	`1765`	`"url": "https://eslint.org/docs/latest/rules/no-param-reassign"`
`1766`	`1766`	`}`