refactor: function name and docs

gajus · Mar 25, 2022 · ba9ddf6 · ba9ddf6
1 parent 5bc8d1e
commit ba9ddf6
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/src/rules/checkTypes.js b/src/rules/checkTypes.js
@@ -167,13 +167,16 @@ export default iterateJsdoc(({
   };
 
   /**
+   * Iterates strict types to see if any should be added to `invalidTypes` (and
+   * the the relevant strict type returned as the new preferred type).
+   *
    * @param {string} typeNodeName
    * @param {string} preferred
    * @param {import('jsdoc-type-pratt-parser/dist/src/index.d.ts').NonTerminalResult} parentNode
    * @param {string[]} invalidTypes
-   * @returns {string} The `preferred` string, optionally changed
+   * @returns {string} The `preferred` type string, optionally changed
    */
-  const check = (typeNodeName, preferred, parentNode, invalidTypes) => {
+  const checkNativeTypes = (typeNodeName, preferred, parentNode, invalidTypes) => {
     let changedPreferred = preferred;
     for (const strictNativeType of strictNativeTypes) {
       if (
@@ -279,7 +282,7 @@ export default iterateJsdoc(({
         typeNodeName, types,
       ]);
     } else if (!noDefaults && type === 'JsdocTypeName') {
-      preferred = check(typeNodeName, preferred, parentNode, invalidTypes);
+      preferred = checkNativeTypes(typeNodeName, preferred, parentNode, invalidTypes);
     }
 
     // For fixer