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-24 21:32:02

#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 anonymous):

 I'm looking at the page some more, and I see:

 {{{
 Description:  Get the head of the input.
             Head is a prefix of the string of the given size.
             If the input is shorter then required,
                        whole input is considered to be the head.
 ...
 Parameters:
 Input:An input string
 N: Length of the head
       For N>=0, at most N characters are extracted.
       For N<0, size(Input)-|N| characters are extracted.
 }}}

 I think adding "at most" before "size(Input)" needs to be done.
 As for the description, I think putting the length semantics there is a
 duplication.

 Hmm.

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