std.containers - WAT

[H. S. Teoh]

On Wed, Mar 28, 2012 at 02:46:19PM +1300, James Miller wrote:
> In helping someone in D.learn, I ended up looking through the
> documentation and code for std.containers.
> 
> There is a lot wrong with whats going on there right now.
[...]

IIRC, Andrei is planning to redesign (or do some major cleanup of)
std.containers at some point.

OTOH, I have to agree that a lot of Phobos documentation can do with
some improvement. I've been trying to do just this whenever I get some
free time. Currently I have a pull request for improving std.range's
docs -- the current docs are very unfriendly to a newbie; you can only
make sense of it if you already know what ranges are.

Anyway, it would be great if more people can help with the docs. Just
create an account on github and fork D-Programming-Language/phobos and
D-Programming-Language/d-programming-language.org, run `git clone` on
both repositories in the same directory, create a new branch, and edit
away.  When you're ready to test, run a `make html` in the phobos
directory. This will generate a copy of the docs on your local machine
under ../web/phobos-prerelease/, which you can point your browser at.
When you're happy with your changes, go to github and initiate a pull
request on phobos from your working branch.


T

-- 
Recently, our IT department hired a bug-fix engineer. He used to work for Volkswagen.