Skip to content

Commit 679fa99

Browse files
committed
change parameter name to --host-path
1 parent 0a1b29e commit 679fa99

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

repo-scripts/api-documenter/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ and then generates files in [Markdown](https://en.wikipedia.org/wiki/Markdown) f
77
## Generate toc for Firebase devsite
88
`api-documenter-fire toc -i temp -p "/docs/reference/js/v9"`
99

10-
`-i` and `-p` are required parameters.
10+
`-i` and `-p` (`--host-path`) are required parameters.
1111
Use `-i` to specify the folder that contains api.json files.
1212
Use `-p` to specify the g3 path that contains the reference docs.
1313

repo-scripts/api-documenter/src/cli/TocAction.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ export class TocAction extends BaseAction {
3838
super.onDefineParameters();
3939

4040
this._g3PathParameter = this.defineStringParameter({
41-
parameterLongName: '--g3-path',
41+
parameterLongName: '--host-path',
4242
parameterShortName: '-p',
43-
argumentName: 'G3PREFIX',
44-
description: `Specifies the path where the reference docs will be written to in g3.
43+
argumentName: 'HOSTPATH',
44+
description: `Specifies the path where the reference docs resides (e.g. g3).
4545
Used to generate paths in the toc`
4646
});
4747

0 commit comments

Comments
 (0)