Fix option name

kgryte · kgryte · commit 843bad7bb900 · 2021-08-26T08:45:29.000-07:00
diff --git a/lib/node_modules/@stdlib/_tools/docs/www/readme-database/README.md b/lib/node_modules/@stdlib/_tools/docs/www/readme-database/README.md
@@ -206,7 +206,7 @@ Options:
   -V,    --version             Print the package version.
          --pattern pattern     Inclusion glob pattern.
          --ignore pattern      Exclusion glob pattern.
-         --base                Internal URL base path.
+         --base path           Internal URL base path.
 ```
 
 </section>
diff --git a/lib/node_modules/@stdlib/_tools/docs/www/readme-fragment-file-tree/README.md b/lib/node_modules/@stdlib/_tools/docs/www/readme-fragment-file-tree/README.md
@@ -52,7 +52,7 @@ The function accepts the following `options`:
 -   **dir**: root directory from which to search for package READMEs. May be either an absolute path or a path relative to the current working directory. Default: current working directory.
 -   **pattern**: glob pattern used to find packages. Default: `'**/package.json'` (note: pattern **must** end with `package.json`).
 -   **ignore**: list of glob patterns used to exclude matches.
--   **version**: semantic versioning number or branch name.
+-   **base**: internal URL base path.
 
 To search from an alternative directory, set the `dir` option.
 
@@ -115,13 +115,13 @@ function done( error ) {
 }
 ```
 
-To have internal URLs of the READMEs link to the correct version of the documentation, set the `version` option. 
+To have internal URLs of the READMEs link to relative (or absolute) documentation pages with a specified base path, set the `base` option. 
 
 <!-- run-disable -->
 
 ```javascript
 var opts = {
-    'version': 'v0.0.87'
+    'base': '/docs/api/v0.0.90/'
 };
 
 build( './build', opts, done );
@@ -216,7 +216,7 @@ Options:
   -V,    --version             Print the package version.
          --pattern pattern     Inclusion glob pattern.
          --ignore pattern      Exclusion glob pattern.
-         --release version     Semantic versioning number or branch name.
+         --base path           Internal URL base path.
   -o,    --out directory       Output directory.
 ```
 
diff --git a/lib/node_modules/@stdlib/_tools/docs/www/readme-fragment-file-tree/bin/cli b/lib/node_modules/@stdlib/_tools/docs/www/readme-fragment-file-tree/bin/cli
@@ -73,8 +73,8 @@ function main() {
 			opts.ignore = flags.ignore;
 		}
 	}
-	if ( flags.release ) {
-		opts.version = flags.release;
+	if ( flags.base ) {
+		opts.base = flags.base;
 	}
 	if ( !flags.out ) {
 		err = new Error( 'insufficient arguments. Must provide an output directory.' );
diff --git a/lib/node_modules/@stdlib/_tools/docs/www/readme-fragment-file-tree/docs/usage.txt b/lib/node_modules/@stdlib/_tools/docs/www/readme-fragment-file-tree/docs/usage.txt
@@ -7,6 +7,6 @@ Options:
   -V,    --version             Print the package version.
          --pattern pattern     Inclusion glob pattern.
          --ignore pattern      Exclusion glob pattern.
-         --release version     Semantic versioning number or branch name.
+         --base path           Internal URL base path.
   -o,    --out directory       Output directory.
 
diff --git a/lib/node_modules/@stdlib/_tools/docs/www/readme-fragment-file-tree/etc/cli_opts.json b/lib/node_modules/@stdlib/_tools/docs/www/readme-fragment-file-tree/etc/cli_opts.json
@@ -3,7 +3,7 @@
 		"pattern",
 		"ignore",
 		"out",
-		"release"
+		"base"
 	],
 	"boolean": [
 		"help",
diff --git a/lib/node_modules/@stdlib/_tools/docs/www/readme-fragment-file-tree/lib/defaults.json b/lib/node_modules/@stdlib/_tools/docs/www/readme-fragment-file-tree/lib/defaults.json
@@ -1,5 +1,5 @@
 {
 	"pattern": "**/package.json",
 	"ignore": [],
-	"version": "develop"
+	"base": "/docs/api/develop/"
 }
diff --git a/lib/node_modules/@stdlib/_tools/docs/www/readme-fragment-file-tree/lib/main.js b/lib/node_modules/@stdlib/_tools/docs/www/readme-fragment-file-tree/lib/main.js
@@ -47,7 +47,7 @@ var debug = logger( 'readme-fragment-file-tree:async' );
 * @param {string} [options.dir] - root directory from which to search for package READMEs
 * @param {string} [options.pattern='**\/package.json'] - glob pattern
 * @param {StringArray} [options.ignore] - glob pattern(s) to exclude matches
-* @param {string} [options.version='develop'] - semantic versioning number or branch name
+* @param {string} [options.base="/docs/api/develop/"] - base path for internal URLs
 * @param {Function} clbk - callback
 * @throws {TypeError} first argument must be a string
 * @throws {TypeError} options argument must be an object
diff --git a/lib/node_modules/@stdlib/_tools/docs/www/readme-fragment-file-tree/lib/validate.js b/lib/node_modules/@stdlib/_tools/docs/www/readme-fragment-file-tree/lib/validate.js
@@ -42,7 +42,7 @@ var RE = /package\.json$/;
 * @param {string} [options.dir] - root directory from which to search for package READMEs
 * @param {string} [options.pattern] - glob pattern
 * @param {StringArray} [options.ignore] - glob pattern(s) to exclude matches
-* @param {string} [options.version] - semantic versioning number or branch name
+* @param {string} [options.base] - base path for internal URLs
 * @returns {(Error|null)} error object or null
 *
 * @example
@@ -82,10 +82,10 @@ function validate( opts, options ) {
 			return new TypeError( 'invalid option. `ignore` option must be a string array. Option: `' + opts.ignore + '`.' );
 		}
 	}
-	if ( hasOwnProp( options, 'version' ) ) {
-		opts.version = options.version;
-		if ( !isString( opts.version ) ) {
-			return new TypeError( 'invalid option. `version` option must be a primitive string. Option: `' + opts.version + '`.' );
+	if ( hasOwnProp( options, 'base' ) ) {
+		opts.base = options.base;
+		if ( !isString( opts.base ) ) {
+			return new TypeError( 'invalid option. `base` option must be a primitive string. Option: `' + opts.base + '`.' );
 		}
 	}
 	return null;

Original file line number	Diff line number	Diff line change
`@@ -73,8 +73,8 @@ function main() {`
`73`	`73`	`opts.ignore = flags.ignore;`
`74`	`74`	`}`
`75`	`75`	`}`
`76`		`- if ( flags.release ) {`
`77`		`- opts.version = flags.release;`
	`76`	`+ if ( flags.base ) {`
	`77`	`+ opts.base = flags.base;`
`78`	`78`	`}`
`79`	`79`	`if ( !flags.out ) {`
`80`	`80`	`err = new Error( 'insufficient arguments. Must provide an output directory.' );`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"pattern": "**/package.json",`
`3`	`3`	`"ignore": [],`
`4`		`- "version": "develop"`
	`4`	`+ "base": "/docs/api/develop/"`
`5`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ var RE = /package\.json$/;`
`42`	`42`	`* @param {string} [options.dir] - root directory from which to search for package READMEs`
`43`	`43`	`* @param {string} [options.pattern] - glob pattern`
`44`	`44`	`* @param {StringArray} [options.ignore] - glob pattern(s) to exclude matches`
`45`		`-* @param {string} [options.version] - semantic versioning number or branch name`
	`45`	`+* @param {string} [options.base] - base path for internal URLs`
`46`	`46`	`* @returns {(Error\|null)} error object or null`
`47`	`47`	`*`
`48`	`48`	`* @example`
`@@ -82,10 +82,10 @@ function validate( opts, options ) {`
`82`	`82`	return new TypeError( 'invalid option. `ignore` option must be a string array. Option: `' + opts.ignore + '`.' );
`83`	`83`	`}`
`84`	`84`	`}`
`85`		`- if ( hasOwnProp( options, 'version' ) ) {`
`86`		`- opts.version = options.version;`
`87`		`- if ( !isString( opts.version ) ) {`
`88`		- return new TypeError( 'invalid option. `version` option must be a primitive string. Option: `' + opts.version + '`.' );
	`85`	`+ if ( hasOwnProp( options, 'base' ) ) {`
	`86`	`+ opts.base = options.base;`
	`87`	`+ if ( !isString( opts.base ) ) {`
	`88`	+ return new TypeError( 'invalid option. `base` option must be a primitive string. Option: `' + opts.base + '`.' );
`89`	`89`	`}`
`90`	`90`	`}`
`91`	`91`	`return null;`