Subject: [boost] Call for Review: Boost.Test documentation rewrite
From: Richard (legalize+jeeves_at_[hidden])
Date: 2014-01-03 02:21:53
[Please do not mail me a copy of your followup]
Boost.Test documentation rewrite:
Please post all comments to this list.
I've been working on this as time permits for a number of months and I
think now things are "finished" enough to warrant wider review. It is
a true rewrite using quickbook; I generally used the implementation
source code as the answer to my questions about things while writing
Early snapshots were reviewed by Tom Kent, Alexander Lamaison,
Paul A. Bristow and Julian Gonggrijp. A special thanks to them for
providing me with useful feedback and suggestions.
The main thing that still remains to be added is a detailed explanation
of the floating-point comparison algorithms used by BOOST_REQUIRE_CLOSE,
BOOST_REQUIRE_CLOSE_FRACTION and BOOST_REQUIRE_SMALL. The corresponding
examples also need to be updated.
The existing online documentation has had all the math symbols
stripped out of it, so it is pretty useless. I'm probably
just going to typeset the formulas with LaTeX and then capture
them as images that are included in the documentation. (See
I'm guessing that modular boost should allow me to clone libs/test,
make all my changes there and then issue a pull request, but I'm not
sure how far along things are with the git transition?
-- "The Direct3D Graphics Pipeline" free book <http://tinyurl.com/d3d-pipeline> The Computer Graphics Museum <http://computergraphicsmuseum.org> The Terminals Wiki <http://terminals.classiccmp.org> Legalize Adulthood! (my blog) <http://legalizeadulthood.wordpress.com>
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk