boost::test documentation gives poor instruction.
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)
Component: |
None → website
|
Owner: |
set to René Rivera
|
Component: |
website → Documentation
|
Owner: |
changed from René Rivera to Matias Capeletto
|
Component: |
Documentation → test
|
Owner: |
changed from Matias Capeletto to Gennadiy Rozental
|
Resolution: |
→ fixed
|
Status: |
new → closed
|
Milestone: |
To Be Determined → Boost 1.59.0
|
Changing component to Documentation.