From a977c15c670763fc587a53e374e7b4befa44a951 Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 27 May 2026 12:24:43 +0000 Subject: [PATCH 1/2] docs: add `@returns {void}` to `_tools/licenses/licenses` main JSDoc Public callback-based functions in the `@stdlib/_tools/licenses` namespace document a `@returns {void}` tag on their `lib/main.js` JSDoc block; the `licenses()` function omitted it. Added the tag in the position used by sibling packages (immediately after the last `@throws` line and before `@example`). Conformance: 3 of 3 other callback-based public functions in the namespace already use this exact tag (`insert-header-file-list`, `remove-header-file-list`, `update-header-file-list`); 9 of 11 packages in the namespace (82%) include some `@returns` tag on their public main; stdlib-wide, 216 of 222 `lib/main.js` files containing `@param {Callback}` include a `@returns` tag (97%). Documentation-only; no behavior change. --- lib/node_modules/@stdlib/_tools/licenses/licenses/lib/main.js | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/node_modules/@stdlib/_tools/licenses/licenses/lib/main.js b/lib/node_modules/@stdlib/_tools/licenses/licenses/lib/main.js index 9ed74cd0cb29..1b03f424d98f 100644 --- a/lib/node_modules/@stdlib/_tools/licenses/licenses/lib/main.js +++ b/lib/node_modules/@stdlib/_tools/licenses/licenses/lib/main.js @@ -52,6 +52,7 @@ var debug = createDebug( 'licenses:main' ); * @throws {TypeError} options argument must be an object * @throws {TypeError} must provide valid options * @throws {TypeError} must provide a function +* @returns {void} * * @example * licenses( onResults ); From 5416b79044d982e67ad0d6f3205670b6fb1bbdfd Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 27 May 2026 12:24:50 +0000 Subject: [PATCH 2/2] docs: drop stray `@private` and add `@returns {void}` in `_tools/licenses/infer` The `infer()` function in `lib/main.js` was tagged `@private`, but the package's `lib/index.js` declares `@module @stdlib/_tools/licenses/infer` and re-exports the function as the package's public API, and `README.md` documents it as a public require target (`var infer = require( '@stdlib/_tools/licenses/infer' )`). Removed the stale `@private` marker. 10 of 11 packages in the namespace (91%) do not mark their main function `@private`. While here, added `@returns {void}` after the last `@param`, matching the namespace convention for callback-based void-returning public functions. Documentation-only; no behavior change. --- lib/node_modules/@stdlib/_tools/licenses/infer/lib/main.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/_tools/licenses/infer/lib/main.js b/lib/node_modules/@stdlib/_tools/licenses/infer/lib/main.js index 8730da082f1c..5c952fb7d095 100644 --- a/lib/node_modules/@stdlib/_tools/licenses/infer/lib/main.js +++ b/lib/node_modules/@stdlib/_tools/licenses/infer/lib/main.js @@ -37,10 +37,10 @@ var debug = logger( 'licenses:infer' ); /** * Infers license information from file content. * -* @private * @param {ObjectArray} pkgs - package data * @param {string} pattern - glob pattern * @param {Callback} clbk - callback to invoke upon completion +* @returns {void} */ function infer( pkgs, pattern, clbk ) { var count;