Re: [Boost-users] Documentation for Boost Range

Subject: Re: [Boost-users] Documentation for Boost Range
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2016-05-17 04:58:02

> -----Original Message-----
> From: Boost-users [mailto:boost-users-bounces_at_[hidden]] On Behalf Of Christian Aichinger
> Sent: 16 May 2016 10:08
> To: Boost-users_at_[hidden]
> Subject: [Boost-users] Documentation for Boost Range
> 
> Boost Range is a cool library, but it's sometimes hard to see how to
> actually use it: which headers to include, how to call it, what the
> return types are.
> 
> To improve this situation, I wrote full, self-contained code examples
> for each function in Boost Range. They are available at:
> 
> https://greek0.net/boost-range
> 
> The examples also include links to the official docs and the into the
> library's source code, as well as a list of headers that give access to
> a specific function.
> 
> I hope it's useful for other people as well. If you have any ideas for
> improvement, please let me know.

Excellent!

This looks a shining example of how examples should be provided as part of the documentation of all Boost (and other) libraries.

(A jamfile that runs all these would be useful too, allowing one to easily add others).

I'd email to the author directly to discuss how this could be amalgamated with the existing docs.

(Using a git fork sounds a good idea, but you might be wasting your time if rejected).

Paul

---
Paul A. Bristow
Prizet Farmhouse
Kendal UK LA8 8AB
[phone]