RE: [boost] Review: Boost.MathConstants docs comments

From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2001-04-23 10:08:39

I'll work on your entirely sensible and reasonable suggestions on
documentation.

The rationale for whatever conclusion on packaging should also be added,
so it isn't reinvented when revisited later.

Are there any other things to add?

Paul

> -----Original Message-----
> From: Beman Dawes [mailto:bdawes_at_[hidden]]
> Sent: Sunday, April 22, 2001 3:23 PM
> To: Boost.org mailing list
> Subject: [boost] Review: Boost.MathConstants docs comments
>
>
> I think the Boost.MathConstants library should be accepted by Boost,
> subject to resolution of the "spirit of C++" issues raised by Ed
> Brey, Matt
> Austern, and others.
>
> The docs need some polishing:
>
> *  List of contents at the start.
>
> *  Table listing the names of the constants.  I'd also like it to
> identify
> the authority for each constant, plus any special notes or warnings
> specific to the particular constant.
>
> *  More hyperlinked cross-references within the document to other
> sections
> of the document would be helpful.
>
> *  Some of the "References & Sources" entries contain URL's which need to
> be set up as HTML links.
>
> *  Some of the "References & Sources" entries are available on
> the web but
> no URL is given. For example, [11] is available at
> http://www.acm.org/pubs/citations/journals/surveys/1991-23-1/p5-go
> ldberg/.
> Such links should be included.  Even if the document itself isn't
> available, the author might deserve a link.
>
> *  Please add an acknowledgement section listing people (Boost or
> otherwise) who have made helpful comments or otherwise aided development.
>
> --Beman
>
>
> To unsubscribe, send email to: <mailto:boost-unsubscribe_at_[hidden]>
>
>
> Your use of Yahoo! Groups is subject to http://docs.yahoo.com/info/terms/
>
>
>
>