clarify wording on short/long

Fixes #37.

A long option is required, a short option is not.
This commit is contained in:
Jarryd Beck 2017-01-30 07:28:57 +11:00
parent e005d07656
commit 1be5f10daf

View File

@ -33,9 +33,9 @@ Then use `add_options`.
("f,file", "File name", cxxopts::value<std::string>()) ("f,file", "File name", cxxopts::value<std::string>())
; ;
Options can be declared with a short and/or long option. A description must be Options are declared with a long and an optional short option. A description
provided. The third argument is the value, if omitted it is boolean. Any type must be provided. The third argument is the value, if omitted it is boolean.
can be given as long as it can be parsed, with operator>>. Any type can be given as long as it can be parsed, with operator>>.
To parse the command line do: To parse the command line do: