[Boost-bugs] [Boost C++ Libraries] #4069: Minor mistakes in documentation

Subject: [Boost-bugs] [Boost C++ Libraries] #4069: Minor mistakes in documentation
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2010-04-05 15:24:31

#4069: Minor mistakes in documentation
---------------------------------------------------+------------------------
 Reporter:  Marek Kurdej <marek.kurdej@…>          |       Owner:  vladimir_prus  
     Type:  Bugs                                   |      Status:  new            
Milestone:  Boost 1.43.0                           |   Component:  program_options
  Version:  Boost 1.42.0                           |    Severity:  Cosmetic       
 Keywords:  doc                                    |  
---------------------------------------------------+------------------------
 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[[BR]]
 68            after -- long name.

 Should be:[[BR]]
 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:[[BR]]
 84                  return 'true' if 'option' specifies *this.

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

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/4069>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.