Subject: Re: [boost] [review] Last day for formal review for Sort library
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2014-11-20 11:21:36
> -----Original Message-----
> From: Boost [mailto:boost-bounces_at_[hidden]] On Behalf Of DUPUIS Etienne
> Sent: 20 November 2014 15:33
> To: boost_at_[hidden]
> Subject: Re: [boost] [review] Last day for formal review for Sort library
> I do not intend to send a formal review but I nevertheless compiled and executed the
> provided test code, with clang 3.5. I added timings and confirmed that in the
> provided test case, this sort is significantly faster than std::sort() provided by the
> latest Linux Mint distribution.
> To the author, I would suggest two very minor issues :
> 1. There are compiler warnings that can easily be avoided (seen with '-Wunused-
> parameter' and '-Wold-style-cast').
> 2. In string_sort_test.cpp, tests are performed using an array of 32 elements. 10 000
> or more should make a more convincing test.
> I have also seen in the documentation that samples are available.
> Indeed, they are in git. However, I would appreciate samples in the documentation,
> without any useless I/O code (useless to understand how to use the sort functions).
> For example, taken from 'keyplusdatasample.cpp' :
> // --------------- Start of code snippet ------------------------
<snip to end>
Eienne is quite correct, and using Quickbook snippets system allows the reader to see both
selected snippets of the program in the documentation, but also allows a clickable link to the full .cpp file.
And since the code example is known to compile and run (you can provide a snippet of the output too)
one can be sure that What You See is exactly What you Will get to Work.
Several people, including me, can help authors to get started on Quickbook documentation. Ask.
--- Paul A. Bristow Prizet Farmhouse Kendal UK LA8 8AB +44 (0) 1539 561830
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk