Re: [Boost-bugs] [Boost C++ Libraries] #6596: Docs bug in boost_1_49_0_beta1/doc/html/boost/algorithm/find_head.html

Subject: Re: [Boost-bugs] [Boost C++ Libraries] #6596: Docs bug in boost_1_49_0_beta1/doc/html/boost/algorithm/find_head.html
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2012-02-25 04:40:22

#6596: Docs bug in boost_1_49_0_beta1/doc/html/boost/algorithm/find_head.html
----------------------------------------------------+-----------------------
  Reporter:  Michael J Smith <emmenjay@…>           |       Owner:  marshall         
      Type:  Bugs                                   |      Status:  assigned         
 Milestone:  Boost 1.50.0                           |   Component:  algorithm        
   Version:  Boost 1.49.0                           |    Severity:  Problem          
Resolution:                                         |    Keywords:  docs typo clarity
----------------------------------------------------+-----------------------

Comment (by Michael J Smith <emmenjay@…>):

 Replying to [comment:5 anonymous]:

 > As for the description, I think putting the length semantics there is a
 duplication.
 [[BR]]

 You may be right.  Let me give you some context.  I've just started
 messing with Boost and had no idea what find_head() did.  I brought up the
 docs and looked at the prototype, then read the description.  I had to
 puzzle over the description for a couple of minutes to figure out what it
 meant.  I figured that there might be a clearer way of saying it.
 [[BR]]

 Talking of a "string" in the description is potentially confusing as the
 input range doesn't have to be a string.[[BR]]

 In that context, "prefix" is not entirely clear.

 I guess I'd like to see a phrase containing something like "the first 'N'
 elements of the input range" in there somewhere.

 Thoughts?

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