[Boost-bugs] [Boost C++ Libraries] #9004: Minor corrections for boost.program_options documentation

Subject: [Boost-bugs] [Boost C++ Libraries] #9004: Minor corrections for boost.program_options documentation
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2013-08-16 11:40:32

#9004: Minor corrections for boost.program_options documentation
------------------------------+-----------------------------
 Reporter:  pfee@…            |      Owner:  vladimir_prus
     Type:  Bugs              |     Status:  new
Milestone:  To Be Determined  |  Component:  program_options
  Version:  Boost 1.54.0      |   Severity:  Cosmetic
 Keywords:                    |
------------------------------+-----------------------------
 Reading the library documentation I noted a few issues.

 http://www.boost.org/doc/libs/1_54_0/doc/html/program_options/overview.html


 == Section "Syntactic Information" ==

 Following the code snippet, the text describes four parameters.  However
 the second option ("compression") is described as "the first option".

 Fixed text: "For the second option, the user must specify a value, using a
 single token."

 == Section: Description formatting ==

 Current text: "compute the indentation for options's description"
 Fixed text: "compute the indentation for option's description"

 Current text: "Each of the paragraph is output"
 Fixed text: "Each of the paragraphs are output" or "Each paragraph is
 output"

 Current text: "Only one tabulator per paragraph is allowed, otherwisee an
 exception"
 Fixed text: "Only one tabulator per paragraph is allowed, otherwise an
 exception"

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