Opened 13 years ago

Closed 12 years ago

#4069 closed Bugs (fixed)

Minor mistakes in documentation

Reported by: Marek Kurdej <marek.kurdej@…> Owned by: Vladimir Prus
Milestone: Boost 1.43.0 Component: program_options
Version: Boost 1.42.0 Severity: Cosmetic
Keywords: doc Cc:

Description

Currently: ​https://svn.boost.org/trac/boost/browser/trunk/boost/program_options/options_description.hpp?rev=58273#L67

67 - otherwise, the part before "," specifies long name and the part
68 after -- long name.

Should be:
68 after -- short name.

Currently: ​https://svn.boost.org/trac/boost/browser/trunk/boost/program_options/options_description.hpp?rev=58273#L84

84 return 'true' is 'option' specifies *this.

Should be:
84 return 'true' if 'option' specifies *this.

Besides, inconsistent use of verbal forms, e.g. 'return' vs. 'returns'.

Attachments (1)

ticket4069.patch​ (2.1 KB ) - added by Marek Kurdej <marek.kurdej@…> 13 years ago.
Unified diff of the suggested changes

Download all attachments as: .zip

Change History (2)

by Marek Kurdej <marek.kurdej@…>, 13 years ago

Attachment: ticket4069.patch​ added

Unified diff of the suggested changes

comment:1 by Vladimir Prus, 12 years ago

Resolution: → fixed
Status: new → closed

(In [62235]) Fix types. Closes #4069.

Note: See TracTickets for help on using tickets.