[Boost-bugs] [Boost C++ Libraries] #6689: For String Algo's trim, documentation is misleading.

Subject: [Boost-bugs] [Boost C++ Libraries] #6689: For String Algo's trim, documentation is misleading.
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2012-03-15 11:11:09

#6689: For String Algo's trim, documentation is misleading.
---------------------------------------------------+------------------------
 Reporter:  Peter Pimley <peter.pimley@…>          |       Owner:  matias       
     Type:  Bugs                                   |      Status:  new          
Milestone:  To Be Determined                       |   Component:  Documentation
  Version:  Boost 1.48.0                           |    Severity:  Cosmetic     
 Keywords:                                         |  
---------------------------------------------------+------------------------
 The documentation for String Algo's trim functions states:

 //When parsing the input from a user, strings **usually** have unwanted
 leading or trailing characters.//

 Is that strictly true?  There's no reason for a string to have leading or
 trailing spaces from, say, getline, a UI component, or a parameter in a
 URL.

 It's certainly true that they //can// contain unwanted characters.  Maybe
 in some situations they //often// do, but I think //usually// is
 misleading.

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