Skip to content

Commit 84ef20b

Browse files
committed
docs: align _tools/pkgs/namespace-deps with namespace JSDoc convention
Added `@example` blocks to the public `namespaceDeps` function's JSDoc (present in 92% of `_tools/pkgs` siblings, 23/25). Examples are lifted from the package README's existing usage snippets; no behavioral or signature changes. https://claude.ai/code/session_018TZhAvyL3P8FYzhGm4G1LH
1 parent 48bd0e5 commit 84ef20b

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

  • lib/node_modules/@stdlib/_tools/pkgs/namespace-deps/lib

lib/node_modules/@stdlib/_tools/pkgs/namespace-deps/lib/main.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,18 @@ function ascending( a, b ) {
6060
* @param {number} [options.level=1] - dependency level
6161
* @throws {TypeError} first argument must be a string
6262
* @returns {(StringArray|EmptyArray)} dependencies
63+
*
64+
* @example
65+
* var deps = namespaceDeps( '@stdlib/assert' );
66+
* // returns [...]
67+
*
68+
* @example
69+
* var opts = {
70+
* 'dev': true
71+
* };
72+
*
73+
* var devDeps = namespaceDeps( '@stdlib/assert', opts );
74+
* // returns [...]
6375
*/
6476
function namespaceDeps( pkg, options ) {
6577
var opts;

0 commit comments

Comments
 (0)