[Boost-bugs] [Boost C++ Libraries] #2500: A minor bug in documentation to MinMax feature (boost/algorithm/minmax_element.hpp)

Subject: [Boost-bugs] [Boost C++ Libraries] #2500: A minor bug in documentation to MinMax feature (boost/algorithm/minmax_element.hpp)
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2008-11-14 10:25:30

#2500: A minor bug in documentation to MinMax feature
(boost/algorithm/minmax_element.hpp)
------------------------------------------------------------------+---------
 Reporter:  Alex Mission aka BugHunter <alex_mission_at_[hidden]>  |       Owner:  matias       
     Type:  Bugs                                                  |      Status:  new          
Milestone:  Boost 1.38.0                                          |   Component:  Documentation
  Version:  Boost 1.36.0                                          |    Severity:  Cosmetic     
 Keywords:  minmax                                                |  
------------------------------------------------------------------+---------
 Please fix a bug in documentation to MinMax feature of BOOS library.

 Bug position.[[BR]]
 http://www.boost.org/doc/libs/1_37_0/libs/algorithm/minmax/index.html


 The exact online address of erroneous place:[[BR]]
 http://www.boost.org/doc/libs/1_37_0/libs/algorithm/minmax/index.html#description


 What is wrong.[[BR]]
 Here is an excerpt from aforementioned paragraph:[[BR]]
 “The family of algorithms comprising first_min_first_max_element,
 first_min_first_max_element, first_min_first_max_element, and
 first_min_first_max_element can be described generically as follows (using
 which and what for first or last): which_min_what_max_element finds the
 (first or last, according to which) smallest element and the (first or
 last, according to what) largest element in the range [first, last).”

 If you pay attention you can notice that the statement[[BR]]
 “first_min_first_max_element”[[BR]]
 is repeated 4 times with no change.

 Corrected sentence is:[[BR]]
 The family of algorithms comprising first_min_first_max_element,
 first_min_last_max_element, last_min_first_max_element, and
 last_min_last_max_element can be described generically as follows (using
 which and what for first or last): which_min_what_max_element finds the
 (first or last, according to which) smallest element and the (first or
 last, according to what) largest element in the range [first, last).


 In other words there is a combination of 2 “parameters”, each of which can
 take two values:[[BR]]
 “first” and “last”:[[BR]]
 first_min_first_max_element[[BR]]
 first_min_last_max_element[[BR]]
 last_min_first_max_element[[BR]]
 last_min_last_max_element[[BR]]


 For more information look at the header file:[[BR]]
 http://www.boost.org/doc/libs/1_37_0/boost/algorithm/minmax_element.hpp

 (minmax_element.hpp)[[BR]]
 where those names are declared.

 Best regards,[[BR]]
 Alex Mission.

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