Opened 13 years ago

Closed 12 years ago

Last modified 7 years ago

#3964 closed Bugs (fixed)

Documentation for BOOST_<level>_CLOSE_FRACTION is incorrect

Reported by: ian@… Owned by: Gennadiy Rozental
Milestone: Boost 1.59.0 Component: test
Version: Boost 1.42.0 Severity: Problem
Keywords: Cc:

Description

The documentation for BOOST_<level>_CLOSE_FRACTION at the url http://www.boost.org/doc/libs/1_42_0/libs/test/doc/html/utf/testing-tools/reference.html is incorrect.

"Last third parameter defines the tolerance for the comparison in percentage units."

should be:

"The third and last parameter defines the tolerance for the comparison as a fractional value."

So, please correct me if I am wrong, but the following are equal:

BOOST_CHECK_CLOSE(x, y, 10);

BOOST_CHECK_CLOSE_FRACTION(x, y, 0.1);

Change History (4)

comment:1 by Steven Watanabe, 13 years ago

Component: Documentationtest
Owner: changed from Matias Capeletto to Gennadiy Rozental

comment:2 by Steven Watanabe, 12 years ago

Resolution: fixed
Status: newclosed

This has been fixed in the trunk.

comment:3 by anonymous, 9 years ago

This problem is still not fixed in the 1.53 release - at least in the online documentation at http://www.boost.org/doc/libs/1_53_0/libs/test/doc/html/utf/testing-tools/reference.html

Both CLOSE and CLOSE_FRACTION descriptions state "Last third parameter defines the tolerance for the comparison in percentage units."

comment:4 by Raffi Enficiaud, 7 years ago

Milestone: Boost 1.43.0Boost 1.59.0
Note: See TracTickets for help on using tickets.