Subject: Re: [boost] Change to documentation writing guidelines
From: Daniel James (daniel_james_at_[hidden])
Date: 2009-06-04 09:22:46
2009/6/4 Stewart, Robert <Robert.Stewart_at_[hidden]>:
> I have a few wording changes to suggest to that moved paragraph:
> The documentation structure required for the C++ Standard is
> an effective way to describe the technical specifications for
> a library. Although terse, that format is familiar to many
> Boost users and is far more precise than most ad hoc formats.
> The following description is based upon §17.3 of the
> Standard. (Note that while final Standard proposals must
> include full standardese wording, which the committee will
> not do for you, that level of detail is not expected of Boost
> library documentation.)
> Note that I've eliminated your #more anchor because I think much more than the targeted section fits that description and that we shouldn't encourage the reader to skip the rest of the material.
OK, I'll check in your changes later.
> I wonder if that section number will continue to apply in the C++0x Standard, when finished. If not, I guess we'll have to clarify it with the version of the Standard.
I looked at the current draft last night and the section number is a
little different (something like 17.5), so I'll do that.
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk