Re: [boost] Boost.Bimap - Informal Review Request

From: Paul Giaccone (paulg_at_[hidden])
Date: 2006-08-09 11:08:52

Paul A Bristow wrote:
> |  -----Original Message-----
> |  From: boost-bounces_at_[hidden] 
> |  [mailto:boost-bounces_at_[hidden]] On Behalf Of Matias Capeletto
> |  Sent: 09 August 2006 14:59
> |  To: boost_at_[hidden]
> |  Subject: Re: [boost] Boost.Bimap - Informal Review Request
> |  
> |  On 8/9/06, John Maddock <john_at_[hidden]> wrote:
> |  
> |  > That aside, it looks like a very successful SOC to me, and 
> |  to be a worthy
> |  > addition to Boost.  Very nice looking docs too BTW!
>
> Nice docs indeed - though I noticed a intially puzzling spelling mistake at
>
> http://cablemodem.fibertel.com.ar/mcape/boost/libs/bimap/doxydoc/namespacebo
> ost_1_1bimap_1_1tags.html
>
> "A ligth non invasive idiom to tag a type"
>
> ligth should be 'light'?
>   
This appears twice. It looks like it should indeed be "light" as the 
correct spelling is used towards the bottom of the page.

There are rather a lot more typos on this page:

* "can not inherited" - should this be "cannot inherit"?
* "another level of indirection, an example ..." is a run-on sentence. 
Replace the comma with either a semicolon or a full stop (a period), 
thus: "indirection; an example" or "indirection. An example"
* "are intend" should be "are intended"
* "user do not" should be "user does not"
* "suitted" should be "suited"
* "As an optional" - should this be "As an option"?
* "in the indexed by declaration" - this doesn't seem to make sense, but 
I haven't looked at what it refers to
* "refered" should be "referred"; "referred by it" should be "referred 
to by it"
* "writer point of view" should probably be "writer's point of view"
* "more simpler" should be "simpler"
* "built-in", "non-invasive" (in three places), "user-friendly" (in two 
places) and "multi-index" should all be hyphenated.

Could I respectfully suggest that you ask someone to proof-read your 
documentation? This will greatly aid the user.

Paul (hoping he hasn't made any typos of his own in this email)