Opened 11 years ago

Closed 11 years ago

Last modified 7 years ago

#5599 closed Bugs (fixed)

boost::test documentation gives poor instruction.

Reported by: Kenneth Burling <burlingk@…> Owned by: Gennadiy Rozental
Milestone: Boost 1.59.0 Component: test
Version: Boost 1.46.1 Severity: Optimization
Keywords: Cc:

Description

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.

Change History (5)

comment:1 by Kenneth Burling <burlingk@…>, 11 years ago

Component: Nonewebsite
Owner: set to René Rivera

comment:2 by Kenneth Burling <burlingk@…>, 11 years ago

Component: websiteDocumentation
Owner: changed from René Rivera to Matias Capeletto

Changing component to Documentation.

comment:3 by anonymous, 11 years ago

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

comment:4 by Gennadiy Rozental, 11 years ago

Resolution: fixed
Status: newclosed

Documentation structure is reworked somewhat (trunk version). Please let me know if it works better.

comment:5 by Raffi Enficiaud, 7 years ago

Milestone: To Be DeterminedBoost 1.59.0
Note: See TracTickets for help on using tickets.