[Boost-bugs] [Boost C++ Libraries] #3964: Documentation for BOOST_<level>_CLOSE_FRACTION is incorrect

Subject: [Boost-bugs] [Boost C++ Libraries] #3964: Documentation for BOOST_<level>_CLOSE_FRACTION is incorrect
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2010-02-27 21:49:56

#3964: Documentation for BOOST_<level>_CLOSE_FRACTION is incorrect
---------------------------------+------------------------------------------
 Reporter:  ian@…                |       Owner:  matias       
     Type:  Bugs                 |      Status:  new          
Milestone:  Boost 1.43.0         |   Component:  Documentation
  Version:  Boost 1.42.0         |    Severity:  Problem      
 Keywords:                       |  
---------------------------------+------------------------------------------
 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);

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