Phobos Documentation - call to action

Zach the Mystic via Digitalmars-d digitalmars-d at puremagic.com
Wed Mar 18 10:55:58 PDT 2015


On Wednesday, 18 March 2015 at 03:45:07 UTC, Walter Bright wrote:
> The bad news: the Phobos documentation sux.
>
> The good news: we can make things a lot better by just filling 
> in blanks. For example, picking a function largely at random:
>
>   http://dlang.org/phobos/std_uni.html#sicmp
>
> There is no Params section, no Returns: section, and no 
> See_Also section. Hence, I wrote a PR for it:
>
>   https://github.com/D-Programming-Language/phobos/pull/3060
>
> There's nothing clever about it, just filling in the blanks. If 
> we all pitch in, we can substantially improve the documentation.
>
> Some guidelines:
>
> 1. The sections Params, Returns, and See_Also need to be there. 
> (Unless there are no parameters, or a void return.)
>
> 2. One PR per function being fixed.
>
> 3. Resist the urge to do more, stay focused simply on filling 
> in the blanks, one PR per function, making things easy to 
> review.

No responses yet -- not that I'm any less guilty than anyone 
else. But maybe this needs to be bumped up to a higher priority 
-- a hiatus on internal development for a couple weeks solely to 
bring documentation up to a minimum. Obviously clear guidelines 
like the ones you just posted are a plus.


More information about the Digitalmars-d mailing list