Skip to content

Commit

Permalink
clarify wording on short/long
Browse files Browse the repository at this point in the history
Fixes jarro2783#37.

A long option is required, a short option is not.
  • Loading branch information
jarro2783 committed Jan 29, 2017
1 parent e005d07 commit 1be5f10
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ Then use `add_options`.
("f,file", "File name", cxxopts::value<std::string>())
;

Options can be declared with a short and/or long option. A description must be
provided. The third argument is the value, if omitted it is boolean. Any type
can be given as long as it can be parsed, with operator>>.
Options are declared with a long and an optional short option. A description
must be provided. The third argument is the value, if omitted it is boolean.
Any type can be given as long as it can be parsed, with operator>>.

To parse the command line do:

Expand Down

0 comments on commit 1be5f10

Please sign in to comment.