Re: [boost] Property_map docs

From: David Abrahams (dave_at_[hidden])
Date: 2002-11-09 21:07:51

"Edward Diener" <eddielee_at_[hidden]> writes:

> I don't understand property_maps. I think the documentation is
> written in a sort of metaprogramming language which precludes its
> use by most programmers, in a way that is different from the
> language in which one usually understands the STL or most of the
> other Boost libraries as an end user.
>
> I would like to urge boost implementors to write their documentation
> first in a language that is for end users to understand and only
> then have advanced sections for other implementors to use. As an
> example of what I think is excellent Boost documentation, I will
> point to Jaako Jarvi's tuple and lambda docs. I am sure Mr. Siek is
> brilliant and knowledgable but his docs on property_map leave me
> gasping for air. Perhaps the fault is mine.

While you may (or may not) be right and justified in your remarks,
your criticism is not constructive. The property map documentation is
written in the same terms as the documentation for "the STL or most of
the other Boost libraries", so it's very hard to imagine what your
problem might be. Please ask specific questions that will help Jeremy
to understand what specifically needs to be clarified.

-- 
                       David Abrahams
   dave_at_[hidden] * http://www.boost-consulting.com
Boost support, enhancements, training, and commercial distribution