Skip to content

Commit 67978eb

Browse files
committed
Move readme example to where it works,
remove superfluous usage string. yargs@>=7 throws exceptions on incorrectly structured builder objects.
1 parent 2a34170 commit 67978eb

File tree

2 files changed

+1
-4
lines changed

2 files changed

+1
-4
lines changed

bin/documentation.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ var argv = yargs
2121
}
2222
})
2323
.example('documentation build foo.js -f md > API.md')
24+
.example('documentation readme index.js -s "API Docs" --github')
2425
.version()
2526
.usage(
2627
`Usage:

src/commands/readme.js

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@ module.exports.description = 'inject documentation into your README.md';
1717
* @private
1818
*/
1919
module.exports.builder = {
20-
usage:
21-
'Usage: documentation readme [--readme-file=README.md] --section "API"' +
22-
' [--compare-only] [other documentationjs options]',
23-
example: 'documentation readme index.js -s "API Docs" --github',
2420
'readme-file': {
2521
describe: 'The markdown file into which to inject documentation',
2622
default: 'README.md'

0 commit comments

Comments
 (0)