Boost logo

Boost :

From: David Abrahams (dave_at_[hidden])
Date: 2003-09-11 09:54:50


Samuel Krempp <krempp_at_[hidden]> writes:

> But IMO having links to the sources somewhere is a good point though.
> Sometimes you want to know a very precise point about the implementation
> of the library, or just get a glance at it.

The source code is on your disk; you know where to find it. Putting
links in the documentation just makes it much less likely that the
user will submit the appropriate bug report which causes the docs to
be improved.

> Of course, the docs -in a perfect world- would be all a potential user
> needs to see to know all about the library, and those that came to
> understand how it works can still access the sources in the web CVS
> interface.

Or by simply looking at the appropriate place in the website. All
the source is there as well.

> But one might not think about going to web CVS interface, or might
> even not know about it..
>
> The way I see it, linking to sources somewhere gives a possibility,
> while requiring those who want to see them to use the CVS web mostly
> wastes time.

There's no need to use CVS web.

    http://www.boost.org/boost/shared_ptr.hpp

> use-the-source-luke'ly yours,

improve-the-docs-ly y'rs,

-- 
Dave Abrahams
Boost Consulting
www.boost-consulting.com

Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk