[Boost-bugs] [Boost C++ Libraries] #5599: boost::test documentation gives poor instruction.

Subject: [Boost-bugs] [Boost C++ Libraries] #5599: boost::test documentation gives poor instruction.
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2011-06-08 12:44:30

#5599: boost::test documentation gives poor instruction.
--------------------------------------------------+-------------------------
 Reporter:  Kenneth Burling <burlingk@…>          |       Owner:              
     Type:  Bugs                                  |      Status:  new         
Milestone:  To Be Determined                      |   Component:  None        
  Version:  Boost 1.46.1                          |    Severity:  Optimization
 Keywords:                                        |  
--------------------------------------------------+-------------------------
 I know that the subject line is probably not great.

 http://www.boost.org/doc/libs/1_46_1/libs/test/doc/html/intro.html states
 that it is not intended for anyone with basic needs to actually read
 through the documentation.  It then provides links to the basic unit
 testing information and the tutorials, effectively skipping over the
 section that explains about the "single header" or "precompiled" options
 for using the library.

 It basically jumps past the minimal setup requirements right to how to use
 the library, leaving the new user to have to search to find out why their
 test program didn't compile first try.

 It may be better to either include this information either at the
 beginning of the tutorials, or to have a link to this information on the
 introduction page and then link to the tutorials from there.

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