Re: [boost] [multiprecision] Docs missing the basics

Subject: Re: [boost] [multiprecision] Docs missing the basics
From: Greg Rubino (bibil.thaysose_at_[hidden])
Date: 2011-12-12 09:12:45

On Mon, Dec 12, 2011 at 8:26 AM, Beman Dawes <bdawes_at_[hidden]> wrote:
> Looking at
> http://boost-sandbox.sourceforge.net/libs/multiprecision/doc/html/multiprecision/intro.html
> http://boost-sandbox.sourceforge.net/libs/multiprecision/doc/html/multiprecision/intro/about.html
> I see a lot of details and commentary, but nothing about the big picture.

[snip]
>
> Good luck with this library!
>

I agree with everything Beman said, and have only one small point to
add: be sure to tell the reader early on which headers to #include for
what and what namespace things are in.  This information is not always
easy to find (even in other Boost docs) and I've often found myself
looking in the header files themselves to find out either what the
minimal set of headers are for a piece of functionality.  A good place
for this information might be .../intro/architecture.html if there is
a lot to talk about.

I really hope this library is accepted!

Greg