[Boost-bugs] [Boost C++ Libraries] #4600: Boost interval intersect documention error

Subject: [Boost-bugs] [Boost C++ Libraries] #4600: Boost interval intersect documention error
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2010-08-26 14:11:52

#4600: Boost interval intersect documention error
-----------------------------------------------------+----------------------
 Reporter:  John Cummings <jcummings2@…>             |       Owner:  matias       
     Type:  Bugs                                     |      Status:  new          
Milestone:  To Be Determined                         |   Component:  Documentation
  Version:  Boost 1.44.0                             |    Severity:  Cosmetic     
 Keywords:                                           |  
-----------------------------------------------------+----------------------
 In the documentation for the boost interval library:

 [http://www.boost.org/doc/libs/1_44_0/libs/numeric/interval/doc/interval.htm]

 There are erroneous references to a non-existent "intersection" function.

 Specifically, in the '''"Overview of the library, and usage"''' section at
 the end of the first paragraph and in the '''"Synopsis"'''" section after
 the comment ''/* set manipulation interval functions */'' the function is
 incorrectly called intersection.

 There is no such function by that name. Instead, the function is called
 intersect. The documentation later correctly names and describes the
 function in the '''"Operations and Functions"''' section.

 The fallacious names need to be correct to avoid confusion.

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