luke
/
cxxopt
mirror of https://github.com/jarro2783/cxxopts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Clarify the usage of options with implicit values and help groups (#490) 

* docs: Clarify the usage of options with implicit values

* docs: clarify instructions to print help groups
This commit is contained in:
Nitin Kumar 2026-02-06 01:50:17 +05:30 committed by GitHub
parent a0f13a1528
commit 068f6c582c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -129,10 +129,7 @@ explaining the error.
## Help groups
Options can be placed into groups for the purposes of displaying help messages.
To place options in a group, pass the group as a string to `add_options`. Then,
when displaying the help, pass the groups that you would like displayed as a
vector to the `help` function.
To place options in a group, pass the group as a string to `add_options`. Then, when displaying the help, `help` by default prints help for all groups. If you want to only print help for a specific group, pass the groups that you would like displayed as a vector to the `help` function.
## Positional Arguments
Positional arguments are those given without a preceding flag and can be used
@ -189,6 +186,8 @@ If an option had both, then not specifying it would give the value `"value"`,
writing it on the command line as `--option` would give the value `"implicit"`,
and writing `--option=another` would give it the value `"another"`.
Note that if `option` has an implicit value, specifying `--option another` will not work. You must use `=` syntax - `--option=another` or `-o=another`(assumming `o` is a short name for the option). This is because no argument is required. Hence, there is no good way to determine if the next string is an argument to your option or a positional argument.
Note that the default and implicit value is always stored as a string,
regardless of the type that you want to store it in. It will be parsed as
though it was given on the command line.