Skip to content

Commit

Permalink
Hardcode documentation binary name. Fixes #319
Browse files Browse the repository at this point in the history
  • Loading branch information
tmcw committed Mar 25, 2016
1 parent 72708a0 commit b28ba3d
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion lib/commands/build.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ module.exports.parseArgs = function (yargs) {
default: 'stdout',
alias: 'o'
})
.example('$0 build foo.js -f md > API.md', 'parse documentation in a ' +
.example('documentation build foo.js -f md > API.md', 'parse documentation in a ' +
'file and generate API documentation as Markdown');
};

Expand Down
2 changes: 1 addition & 1 deletion lib/commands/lint.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ module.exports = lint;
module.exports.description = 'check for common style and uniformity mistakes';
module.exports.parseArgs = function (yargs) {
return yargs
.example('$0 lint project.js', 'check documentation style')
.example('documentation lint project.js', 'check documentation style')
.help('help');
};

Expand Down
4 changes: 2 additions & 2 deletions lib/commands/readme.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ var build = require('./build');
module.exports = readme;
module.exports.description = 'inject documentation into your README.md';
module.exports.parseArgs = function (yargs) {
return yargs.usage('Usage: $0 readme [--readme-file=README.md] --section "API"' +
return yargs.usage('Usage: documentation readme [--readme-file=README.md] --section "API"' +
' [--compare-only] [other documentationjs options]')
.option('readme-file', {
describe: 'The markdown file into which to inject documentation',
Expand All @@ -33,7 +33,7 @@ module.exports.parseArgs = function (yargs) {
default: false
})
.help('help')
.example('$0 readme index.js -s "API Docs" --github');
.example('documentation readme index.js -s "API Docs" --github');
};

function readme(documentation, parsedArgs) {
Expand Down

0 comments on commit b28ba3d

Please sign in to comment.