Skip to content
This repository has been archived by the owner on Jun 27, 2020. It is now read-only.

Commit

Permalink
Improve argument descriptions/help
Browse files Browse the repository at this point in the history
  • Loading branch information
snugfox committed Dec 6, 2015
1 parent 6d90f76 commit c876f06
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,23 @@ usage: wres [-h] [-v] [-d DENSITY] [-f FORMAT] [-o OUTPUT] [-p]
Resume webpage generator
Positional arguments:
resume YAML or JSON file containing the resume information
resume YAML or JSON file containing the resume information.
Optional arguments:
-h, --help Show this help message and exit.
-v, --version Show program's version number and exit.
-d DENSITY, --density DENSITY
Use the alternative, compact template.
Specify the resume density (default: comfy).
-f FORMAT, --format FORMAT
Specify an external Jade template to use (not
recommended).
-o OUTPUT, --output OUTPUT
Specify output file.
-p, --pretty Output pretty HTML.
Specify output file (default: STDOUT).
-p, --pretty Output indented HTML (default: false).
--print-template Print the template resume and exit.
-t THEME, --theme THEME
Specify a pre-defined or external CSS theme.
Specify a pre-defined or external CSS theme (default:
plain).
--list-themes List pre-defined themes.
```

Expand Down
11 changes: 6 additions & 5 deletions bin/wres
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,9 @@ var argparser = new ArgumentParser({
argparser.addArgument(
['-d', '--density'],
{
choices: ['compact', 'comfy', 'cozy'],
defaultValue: ['comfy'],
help: 'Use the alternative, compact template.',
help: 'Specify the resume density (default: comfy).',
metavar: 'DENSITY',
nargs: 1
}
Expand All @@ -50,7 +51,7 @@ argparser.addArgument(
argparser.addArgument(
['-o', '--output'],
{
help: 'Specify output file.',
help: 'Specify output file (default: STDOUT).',
metavar: 'OUTPUT',
nargs: 1
}
Expand All @@ -59,7 +60,7 @@ argparser.addArgument(
['-p', '--pretty'],
{
action: 'storeTrue',
help: 'Output pretty HTML.'
help: 'Output indented HTML (default: false).'
}
);
argparser.addArgument(
Expand All @@ -73,7 +74,7 @@ argparser.addArgument(
argparser.addArgument(
['-t', '--theme'],
{
help: 'Specify a pre-defined or external CSS theme.',
help: 'Specify a pre-defined or external CSS theme (default: plain).',
nargs: 1
}
);
Expand All @@ -88,7 +89,7 @@ argparser.addArgument(
argparser.addArgument(
['resume'],
{
help: 'YAML or JSON file containing the resume information',
help: 'YAML or JSON file containing the resume information.',
nargs: '?'
}
);
Expand Down

0 comments on commit c876f06

Please sign in to comment.