Skip to content

Commit fca5441

Browse files
committed
Update option description
1 parent 6c675a8 commit fca5441

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

lib/node_modules/@stdlib/_tools/docs/www/server/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ The function accepts the following `options`:
5858

5959
- **address**: server address. Default: `'127.0.0.1'`.
6060
- **hostname**: server hostname (e.g., `localhost` ).
61-
- **latest**: virtual path for mapping a `version` to the "latest" documentation (e.g., this could simply be a `version`, such as `v0.0.90`, or an arbitrary path, such as `foo/bar/beep/boop`). When set to an empty string (as is the default), the server does **not** provide any such mapping. Default: `''`.
61+
- **latest**: path to the "latest" documentation (e.g., this could simply be a `version`, such as `v0.0.90`, or an arbitrary (relative) path, such as `foo/bar/beep/boop`). When set to an empty string (as is the default), the server does **not** virtually map the version `latest` to a particular set of documentation resources. Default: `''`.
6262
- **logger**: `boolean` indicating whether to enable logging. Default: `false`.
6363
- **port**: server port. Default: `0` (i.e., randomly assigned).
6464
- **prefix**: URL path prefix used to create a virtual mount path for a static directory (e.g., `/docs/api/` to match the API documentation virtual mount path). Default: `'/'`.
@@ -269,7 +269,7 @@ Options:
269269
-V, --version Print the package version.
270270
--address address Server address. Default: 127.0.0.1.
271271
--hostname hostname Server hostname.
272-
--latest path Virtual path to the "latest" documentation.
272+
--latest path Path to the "latest" documentation.
273273
--logger Enable logging.
274274
--port port Server port. Default: 0.
275275
--prefix prefix Virtual mount path for static files.

lib/node_modules/@stdlib/_tools/docs/www/server/docs/usage.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Options:
77
-V, --version Print the package version.
88
--address address Server address. Default: 127.0.0.1.
99
--hostname hostname Server hostname.
10-
--latest path Virtual path to the "latest" documentation.
10+
--latest path Path to the "latest" documentation.
1111
--logger Enable logging.
1212
--port port Server port. Default: 0.
1313
--prefix prefix Virtual mount path for static files.

lib/node_modules/@stdlib/_tools/docs/www/server/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ var routes = require( './routes' );
4040
* @param {Options} [options] - server options
4141
* @param {string} [options.address="127.0.0.1"] - server address
4242
* @param {string} [options.hostname] - server hostname
43-
* @param {string} [options.latest=""] - virtual path for mapping a version to the "latest" documentation (e.g., this could simply be a version, such as `v0.0.90`, or an arbitrary path, such as `foo/bar/beep/boop`)
43+
* @param {string} [options.latest=""] - path to the "latest" documentation (e.g., this could simply be a version, such as `v0.0.90`, or an arbitrary path, such as `foo/bar/beep/boop`)
4444
* @param {boolean} [options.logger=false] - boolean indicating whether to enable logging
4545
* @param {NonNegativeInteger} [options.port=0] - server port
4646
* @param {string} [options.prefix="/"] - URL path prefix used to create a virtual mount path for a static directory

lib/node_modules/@stdlib/_tools/docs/www/server/lib/routes/pkgs.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var RE_FRAGMENT = /{{\s*FRAGMENT\s*}}/;
4242
*
4343
* @private
4444
* @param {Options} opts - options
45-
* @param {string} options.latest - virtual path for mapping a version to the "latest" documentation
45+
* @param {string} options.latest - path to the "latest" documentation
4646
* @param {string} options.root - root documentation directory
4747
* @param {string} options.template - application shell template
4848
* @returns {Object} route declaration

lib/node_modules/@stdlib/_tools/docs/www/server/lib/validate.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
3737
* @param {Options} options - function options
3838
* @param {string} [options.address] - server address
3939
* @param {string} [options.hostname] - server hostname
40-
* @param {string} [options.latest] - virtual path for mapping a version to the "latest" documentation
40+
* @param {string} [options.latest] - path to the "latest" documentation
4141
* @param {boolean} [options.logger] - boolean indicating whether to enable logging
4242
* @param {NonNegativeInteger} [options.port] - server port
4343
* @param {string} [options.prefix] - URL path prefix used to create a virtual mount path for a static directory

0 commit comments

Comments
 (0)