Worst Phobos documentation evar!

[H. S. Teoh via Digitalmars-d]

On Sat, Dec 27, 2014 at 05:00:00PM -0800, Walter Bright via Digitalmars-d wrote:
> This is so bad there isn't even a direct link to it, it hides in
> shame. Just go here:
> 
>     http://dlang.org/phobos/std_encoding.html#.transcode
> 
> and scroll up one entry. Here it is:
> 
>    size_t encode(Tgt, Src, R)(in Src[] s, R range);
> 
>    Encodes c in units of type E and writes the result to the output
>    range R.  Returns the number of Es written.
> 
> Let me enumerate the awesomeness of its awfulness:
> 
> 1. No 'Return:' block, though it obviously returns a value.
> 2. No 'Params:' block, though it obviously has parameters.

There's a related bug that limits the usefulness of Params blocks:

	https://issues.dlang.org/show_bug.cgi?id=13270


On another note, the wall-of-text-function-signature complaint that
people have voiced can be solved with:

	https://issues.dlang.org/show_bug.cgi?id=13676

I'll take a stab at this sometime in the near future, but before putting
too much time into it, I'd like to know, is this the right direction to
go? Will it be approved?


There's also a minor cosmetic issue with template ddocs:

	https://issues.dlang.org/show_bug.cgi?id=13272


T

-- 
Why waste time learning, when ignorance is instantaneous? -- Hobbes, from Calvin & Hobbes