Skip to content

Commit 2eee11a

Browse files
committed
Update option descriptions
1 parent e031c41 commit 2eee11a

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

lib/node_modules/@stdlib/_tools/pkgs/namespaces/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ function onList( error, names ) {
4747

4848
The function accepts the following `options`:
4949

50-
- **dir**: root directory from which to search for namespaces. May be either an absolute path or a path relative to the `stdlib/lib/node_modules/` directory. Default: `/path/to/stdlib/lib/node_modules/`.
50+
- **dir**: directory from which to search for namespaces. May be either an absolute path or a path relative to the `stdlib/lib/node_modules/` directory (e.g., `./@stdlib/math`). Default: `/path/to/stdlib/lib/node_modules/`.
5151
- **pattern**: glob pattern used to find namespaces. Default: `'**/package.json'` (note: pattern **must** end with `package.json`).
5252
- **ignore**: list of glob patterns used to exclude matches.
5353

lib/node_modules/@stdlib/_tools/pkgs/namespaces/lib/async.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ var defaults = require( './defaults.json' );
3434
* Asynchronously lists stdlib namespaces.
3535
*
3636
* @param {Options} [options] - function options
37-
* @param {string} [options.dir] - root directory from which to search for namespaces
37+
* @param {string} [options.dir] - directory from which to search for namespaces
3838
* @param {string} [options.pattern='**\/package.json'] - glob pattern
3939
* @param {StringArray} [options.ignore] - glob pattern(s) to exclude matches
4040
* @param {Callback} clbk - callback to invoke after finding namespaces

lib/node_modules/@stdlib/_tools/pkgs/namespaces/lib/sync.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var defaults = require( './defaults.json' );
3333
* Synchronously lists namespaces.
3434
*
3535
* @param {Options} [options] - function options
36-
* @param {string} [options.dir] - root directory from which to search for namespaces
36+
* @param {string} [options.dir] - directory from which to search for namespaces
3737
* @param {string} [options.pattern='**\/package.json'] - glob pattern
3838
* @param {StringArray} [options.ignore] - glob pattern(s) to exclude matches
3939
* @throws {TypeError} options argument must be an object

lib/node_modules/@stdlib/_tools/pkgs/namespaces/lib/validate.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ var RE = /package\.json$/;
3939
* @private
4040
* @param {Object} opts - destination object
4141
* @param {Options} options - function options
42-
* @param {string} [options.dir] - root directory from which to search for namespaces
42+
* @param {string} [options.dir] - directory from which to search for namespaces
4343
* @param {string} [options.pattern] - glob pattern
4444
* @param {StringArray} [options.ignore] - glob pattern(s) to exclude matches
4545
* @returns {(Error|null)} error object or null

0 commit comments

Comments
 (0)