Skip to content

Commit

Permalink
doc: edit help example to align with actual output (#1271)
Browse files Browse the repository at this point in the history
  • Loading branch information
weswinder authored and bcoe committed Jan 28, 2019
1 parent bc0ee40 commit e0c62c8
Showing 1 changed file with 22 additions and 9 deletions.
31 changes: 22 additions & 9 deletions docs/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ var argv = require('yargs')
.demandOption(['f'])
.help('h')
.alias('h', 'help')
.epilog('copyright 2015')
.epilog('copyright 2019')
.argv;

var fs = require('fs');
Expand All @@ -302,25 +302,38 @@ s.on('end', function () {
````

***
$ node line_count.js count
$ node line_count.js
Usage: line_count.js <command> [options]

Commands:
count Count the lines in a file
line_count.js count Count the lines in a file

Options:
-f, --file Load a file [required]
-h, --help Show help [boolean]
--version Show version number [boolean]
-f, --file Load a file [required]
-h, --help Show help [boolean]

Examples:
line_count.js count -f foo.js count the lines in the given file

copyright 2015
copyright 2019

Missing required argument: f

$ node line_count.js count
line_count.js count

Count the lines in a file

Options:
--version Show version number [boolean]
-f, --file Load a file [required]
-h, --help Show help [boolean]

Missing required arguments: f
Missing required argument: f

$ node line_count.js count --file line_count.js
26
25

$ node line_count.js count -f line_count.js
26
25

0 comments on commit e0c62c8

Please sign in to comment.