Opened 14 years ago
Closed 14 years ago
#2500 closed Bugs (fixed)
A minor bug in documentation to MinMax feature (boost/algorithm/minmax_element.hpp)
Reported by: | Owned by: | Matias Capeletto | |
---|---|---|---|
Milestone: | Boost 1.38.0 | Component: | Documentation |
Version: | Boost 1.36.0 | Severity: | Cosmetic |
Keywords: | minmax | Cc: | alex_mission@… |
Description
Please fix a bug in documentation to MinMax feature of BOOS library.
Bug position.
http://www.boost.org/doc/libs/1_37_0/libs/algorithm/minmax/index.html
The exact online address of erroneous place:
http://www.boost.org/doc/libs/1_37_0/libs/algorithm/minmax/index.html#description
What is wrong.
Here is an excerpt from aforementioned paragraph:
“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
“first_min_first_max_element”
is repeated 4 times with no change.
Corrected sentence is:
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:
“first” and “last”:
first_min_first_max_element
first_min_last_max_element
last_min_first_max_element
last_min_last_max_element
For more information look at the header file:
http://www.boost.org/doc/libs/1_37_0/boost/algorithm/minmax_element.hpp (minmax_element.hpp)
where those names are declared.
Best regards,
Alex Mission.
Change History (2)
comment:1 by , 14 years ago
comment:2 by , 14 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
Oh, sorry, it should have been used bold to emphasize the erroneous places. Look, please, at the updated text.
Here is an excerpt from aforementioned paragraph:
“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).”