From 5bf80135e241dac364a8d7559b121d6f289ae27b Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 24 Jun 2026 20:14:08 +0000 Subject: [PATCH 1/4] docs: remove redundant `@returns` tag from `@stdlib/fs/open` Drops the `@returns {void}` JSDoc tag from the exported async `open` function in `lib/main.js`. The tag is redundant for a callback-style API whose result channel is the callback, and is inconsistent with sibling packages in the `@stdlib/fs/*` namespace: 14 of 16 packages (87.5%) omit a `@returns` tag on the exported async function in `lib/main.js` / `lib/async.js`. PR-URL: TBD Reviewed-by: TBD --- lib/node_modules/@stdlib/fs/open/lib/main.js | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/fs/open/lib/main.js b/lib/node_modules/@stdlib/fs/open/lib/main.js index 49e87365d138..0e084d3ea5ac 100644 --- a/lib/node_modules/@stdlib/fs/open/lib/main.js +++ b/lib/node_modules/@stdlib/fs/open/lib/main.js @@ -33,7 +33,6 @@ var defaults = require( './defaults.json' ); * @param {(string|number)} [flags='r'] - file system flags * @param {integer} [mode=0o666] - file mode * @param {Function} clbk - callback to invoke after opening a file -* @returns {void} * * @example * var closeSync = require( '@stdlib/fs/close' ).sync; From 75d3c1f8768f56293ca2c864174fd486b86ca58d Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 24 Jun 2026 20:14:14 +0000 Subject: [PATCH 2/4] docs: remove redundant `@returns` tag from `@stdlib/fs/resolve-parent-paths` Drops the `@returns {void}` JSDoc tag from the exported async `resolveParentPaths` function in `lib/main.js`. The tag is redundant for a callback-style API whose result channel is the callback, and is inconsistent with sibling packages in the `@stdlib/fs/*` namespace: 14 of 16 packages (87.5%) omit a `@returns` tag on the exported async function in `lib/main.js` / `lib/async.js`. Inner helper functions (`first`, `some`, `all`, `each`) retain their `@returns {void}` tags. PR-URL: TBD Reviewed-by: TBD --- lib/node_modules/@stdlib/fs/resolve-parent-paths/lib/main.js | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/fs/resolve-parent-paths/lib/main.js b/lib/node_modules/@stdlib/fs/resolve-parent-paths/lib/main.js index 3a637720560b..54233cd13745 100644 --- a/lib/node_modules/@stdlib/fs/resolve-parent-paths/lib/main.js +++ b/lib/node_modules/@stdlib/fs/resolve-parent-paths/lib/main.js @@ -359,7 +359,6 @@ function each( paths, dir, done ) { * @throws {TypeError} callback argument must be a function * @throws {TypeError} options argument must be an object * @throws {TypeError} must provide valid options -* @returns {void} * * @example * resolveParentPaths( [ 'package.json', 'package-lock.json' ], onPaths ); From 78fba9a6056d1a291291591219f32474c435830b Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 24 Jun 2026 20:18:19 +0000 Subject: [PATCH 3/4] Revert "docs: remove redundant `@returns` tag from `@stdlib/fs/resolve-parent-paths`" This reverts commit 75d3c1f8768f56293ca2c864174fd486b86ca58d. --- lib/node_modules/@stdlib/fs/resolve-parent-paths/lib/main.js | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/node_modules/@stdlib/fs/resolve-parent-paths/lib/main.js b/lib/node_modules/@stdlib/fs/resolve-parent-paths/lib/main.js index 54233cd13745..3a637720560b 100644 --- a/lib/node_modules/@stdlib/fs/resolve-parent-paths/lib/main.js +++ b/lib/node_modules/@stdlib/fs/resolve-parent-paths/lib/main.js @@ -359,6 +359,7 @@ function each( paths, dir, done ) { * @throws {TypeError} callback argument must be a function * @throws {TypeError} options argument must be an object * @throws {TypeError} must provide valid options +* @returns {void} * * @example * resolveParentPaths( [ 'package.json', 'package-lock.json' ], onPaths ); From e64f07dc471096bd0ec94ab3157b312fdd1661cf Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 24 Jun 2026 20:18:20 +0000 Subject: [PATCH 4/4] Revert "docs: remove redundant `@returns` tag from `@stdlib/fs/open`" This reverts commit 5bf80135e241dac364a8d7559b121d6f289ae27b. --- lib/node_modules/@stdlib/fs/open/lib/main.js | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/node_modules/@stdlib/fs/open/lib/main.js b/lib/node_modules/@stdlib/fs/open/lib/main.js index 0e084d3ea5ac..49e87365d138 100644 --- a/lib/node_modules/@stdlib/fs/open/lib/main.js +++ b/lib/node_modules/@stdlib/fs/open/lib/main.js @@ -33,6 +33,7 @@ var defaults = require( './defaults.json' ); * @param {(string|number)} [flags='r'] - file system flags * @param {integer} [mode=0o666] - file mode * @param {Function} clbk - callback to invoke after opening a file +* @returns {void} * * @example * var closeSync = require( '@stdlib/fs/close' ).sync;