[Boost-bugs] [Boost C++ Libraries] #4232: Minor documentation feedbacks

Subject: [Boost-bugs] [Boost C++ Libraries] #4232: Minor documentation feedbacks
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2010-05-17 21:07:11

#4232: Minor documentation feedbacks
--------------------------------+-------------------------------------------
 Reporter:  Guillaume Labourey  |       Owner:  djowel  
     Type:  Bugs                |      Status:  new     
Milestone:  Boost 1.43.0        |   Component:  spirit  
  Version:  Boost 1.44.0        |    Severity:  Cosmetic
 Keywords:                      |  
--------------------------------+-------------------------------------------
 Hello,

 On the documentation, I think there is a little "copy-paste" mistake in a
 Qi parser description spirit/doc/qi/concepts.qbk from line 26 to line 30:

 The /Parser/ is the most fundamental concept. A Parser has a member
 function, `parse`, that accepts a first-last __fwditer__ pair andreturns
 bool as its result. The iterators delimit the data being parsed.function
 `parse`, that accepts a

 first-last __fwditer__ pair and
 returns `bool` as its result. The iterators delimit the data being parsed.
 The Parser's `parse` member function returns `true` if the parse
 succeeds, in which case the first iterator is advanced accordingly. Each
 Parser can represent a specific pattern or algorithm, or it can be a
 more complex parser formed as a composition of other Parsers.

 It should be replaced by:

 The /Parser/ is the most fundamental concept. A Parser has a member
 function, `parse`, that accepts a first-last __fwditer__ pair and returns
 bool as its result. The iterators delimit the data being parsed.
 The Parser's `parse` member function returns `true` if the parse
 succeeds, in which case the first iterator is advanced accordingly. Each
 Parser can represent a specific pattern or algorithm, or it can be a
 more complex parser formed as a composition of other Parsers.

 Best regards, Guillaume

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