Skip to content

Commit 55ef0cc

Browse files
committed
Make docs consistent
1 parent 66ab2ac commit 55ef0cc

File tree

4 files changed

+12
-11
lines changed

4 files changed

+12
-11
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ you can use the `include` property,
174174

175175
--version Output the version number
176176
--config-path Path to the JSON file containing the blobpack config
177-
--tmp-root Path to tmp working directory
177+
--tmp-root Path to a temporary working directory
178178
--config-root Path to the directory containing the artifact configs
179179
--resources-root Path to the directory all resources are relative to
180180
--dist-root Path to the directory to output artifacts

bin/blobpack.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,10 @@ const docs = `
5656
5757
--version Output the version number
5858
--config-path Path to the JSON file containing the blobpack config
59-
--tmp-root Path to tmp working directory
60-
--config-root Output the version number
61-
--resources-root Output the version number
62-
--dist-root Output the version number
59+
--tmp-root Path to a temporary working directory
60+
--config-root Path to the directory containing the artifact configs
61+
--resources-root Path to the directory all resources are relative to
62+
--dist-root Path to the directory to output artifacts
6363
`
6464

6565
if (args._[0] === 'help') {

lib/build.doc.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
* @function build
44
* @param {Object} parameters
55
* @param {string} [parameters.configPath=package.json] Path to JSON file with a blobpack config key.
6-
* @param {string} [parameters.tmpRoot=s3] Temporary directory to download artifacts.
7-
* @param {string} [parameters.configRoot=config] Path where configs are located.
8-
* @param {string} [parameters.resourcesRoot=resources] Path where resources are located.
9-
* @param {string} [parameters.distRoot=dist] Path to output artifacts.
6+
* @param {string} [parameters.tmpRoot=tmp] Path to a temporary working directory.
7+
* @param {string} [parameters.configRoot=config] Path to the directory containing the artifact configs.
8+
9+
* @param {string} [parameters.resourcesRoot=./] Path to the directory all resources are relative to
10+
* @param {string} [parameters.distRoot=dist] Path to the directory to output artifacts
1011
* @param {string} [parameters.logger=console] Console compatible logger.
1112
* @returns {string[]} Generated artifacts paths.
1213
*/

lib/install.doc.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
* Download and install a Benthos binary.
33
* @function install
44
* @param {Object} parameters
5-
* @param {string} [parameters.configPath=package.json] Path to JSON file with a benthos config key.
6-
* @param {string} [parameters.tmpRoot=s3] Temporary directory to download artifacts.
5+
* @param {string} [parameters.configPath=package.json] Path to the JSON file containing the blobpack config.
6+
* @param {string} [parameters.tmpRoot=tmp] Path to a temporary working directory.
77
* @param {string} [parameters.logger=console] Console compatible logger.
88
* @returns {string} Path to the saved binary.
99
*/

0 commit comments

Comments
 (0)