improve comment

gurgunday · gurgunday · commit c0179f46e1fa · 2024-09-11T09:25:59.000+02:00
diff --git a/rules/always-return.js b/rules/always-return.js
@@ -140,7 +140,7 @@ function getRootObjectName(node) {
 }
 
 /**
- * Checks if the node is an assignment to an ignored variable. Use getRootObjectName to get the variable name.
+ * Checks if the node is an assignment to an ignored variable.
  * @param {Node} node
  * @param {string[]} ignoredVars
  * @returns {boolean}

Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,7 @@ function getRootObjectName(node) {`
`140`	`140`	`}`
`141`	`141`
`142`	`142`	`/**`
`143`		`- * Checks if the node is an assignment to an ignored variable. Use getRootObjectName to get the variable name.`
	`143`	`+ * Checks if the node is an assignment to an ignored variable.`
`144`	`144`	`* @param {Node} node`
`145`	`145`	`* @param {string[]} ignoredVars`
`146`	`146`	`* @returns {boolean}`