Opened 15 years ago
Closed 14 years ago
#1530 closed Bugs (fixed)
Program options documentation - Overview - Syntactic Information example typo
| Reported by: | Owned by: | Vladimir Prus | |
|---|---|---|---|
| Milestone: | To Be Determined | Component: | program_options |
| Version: | Boost 1.34.1 | Severity: | Cosmetic |
| Keywords: | Cc: |
Description
Program options documentation -> Overview -> Syntactic Information
In the example: value<string>()->zero_token() should be value<string>()->zero_tokens() with an 's'
The following description is also confusing, referring to a first, third, and last option.
How about not only correcting position but also referring by name: "For the first parameter (help), we specify only the name and the description. No value can be specified in the parsed source. For the first option (compression), the user must specify a value, using a single token. For the second option (verbose), the user may either provide a single token for the value, or no token at all. For the last option (email), the value can span several tokens. For example, the following command line is OK:"
(In [45448]) Clarify docs. Fixes #1530.