chore: update description of SourceCode#getDeclaredVariables

[mdjermanovic]

Prerequisites checklist

• I have read the contributing guidelines.

What is the purpose of this pull request? (put an "X" next to an item)

[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[x] Other, please explain:

Refs discussion under #17059 (comment).

In my opinion, the current JSDoc description of SourceCode#getDeclaredVariables is misleading because it suggests that this method returns getScope(node).variables. Considering the name of this method, that would make sense for readers, but it isn't really what this method returns.

What changes did you make? (Give an overview)

Updated the JSDoc description of SourceCode#getDeclaredVariables.

Is there anything you'd like reviewers to focus on?

The most accurate and least confusing description is the one in https://eslint.org/docs/latest/extend/custom-rules, which describes what this method returns for each node type:

eslint/docs/src/extend/custom-rules.md

Lines 122 to 131 in 6e2df71

	* `getDeclaredVariables(node)` - (**Deprecated:** Use `SourceCode#getDeclaredVariables(node)` instead.) returns a list of [variables](./scope-manager-interface#variable-interface) declared by the given node. This information can be used to track references to variables.
	* If the node is a `VariableDeclaration`, all variables declared in the declaration are returned.
	* If the node is a `VariableDeclarator`, all variables declared in the declarator are returned.
	* If the node is a `FunctionDeclaration` or `FunctionExpression`, the variable for the function name is returned, in addition to variables for the function parameters.
	* If the node is an `ArrowFunctionExpression`, variables for the parameters are returned.
	* If the node is a `ClassDeclaration` or a `ClassExpression`, the variable for the class name is returned.
	* If the node is a `CatchClause`, the variable for the exception is returned.
	* If the node is an `ImportDeclaration`, variables for all of its specifiers are returned.
	* If the node is an `ImportSpecifier`, `ImportDefaultSpecifier`, or `ImportNamespaceSpecifier`, the declared variable is returned.
	* Otherwise, if the node does not declare any variables, an empty array is returned.

Perhaps we should also copy & paste that list into the JSDoc description, or add a reference to this document.

[netlify]

✅ Deploy Preview for docs-eslint canceled.

Name	Link
🔨 Latest commit	89d6013
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/64314357098e7e000819d850

[snitin315]

LGTM. Will leave it open in case someone else wants to review it.

[fasttime]

Thanks for the edit, this makes sense to me. Won't this change conflict with #17059 if we merge it now?

#17059 is merged now, so okay to merging this PR. @mdjermanovic Would you still like to add a reference to the section about getDeclaredVariables() in custom-rules.md?

[mdjermanovic]

@mdjermanovic Would you still like to add a reference to the section about getDeclaredVariables() in custom-rules.md?

Since there isn't currently a separate, linkable section at the moment, I think this would be fine for now.

[fasttime]

LGTM, thanks again.