Skip to content

Commit b28ba3d

Browse files
committed
Hardcode documentation binary name. Fixes #319
1 parent 72708a0 commit b28ba3d

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

lib/commands/build.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ module.exports.parseArgs = function (yargs) {
2424
default: 'stdout',
2525
alias: 'o'
2626
})
27-
.example('$0 build foo.js -f md > API.md', 'parse documentation in a ' +
27+
.example('documentation build foo.js -f md > API.md', 'parse documentation in a ' +
2828
'file and generate API documentation as Markdown');
2929
};
3030

lib/commands/lint.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ module.exports = lint;
66
module.exports.description = 'check for common style and uniformity mistakes';
77
module.exports.parseArgs = function (yargs) {
88
return yargs
9-
.example('$0 lint project.js', 'check documentation style')
9+
.example('documentation lint project.js', 'check documentation style')
1010
.help('help');
1111
};
1212

lib/commands/readme.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ var build = require('./build');
1010
module.exports = readme;
1111
module.exports.description = 'inject documentation into your README.md';
1212
module.exports.parseArgs = function (yargs) {
13-
return yargs.usage('Usage: $0 readme [--readme-file=README.md] --section "API"' +
13+
return yargs.usage('Usage: documentation readme [--readme-file=README.md] --section "API"' +
1414
' [--compare-only] [other documentationjs options]')
1515
.option('readme-file', {
1616
describe: 'The markdown file into which to inject documentation',
@@ -33,7 +33,7 @@ module.exports.parseArgs = function (yargs) {
3333
default: false
3434
})
3535
.help('help')
36-
.example('$0 readme index.js -s "API Docs" --github');
36+
.example('documentation readme index.js -s "API Docs" --github');
3737
};
3838

3939
function readme(documentation, parsedArgs) {

0 commit comments

Comments
 (0)