We need better documentation for functions with ranges and templates
Jack Stouffer via Digitalmars-d
digitalmars-d at puremagic.com
Tue Dec 15 08:46:06 PST 2015
On Tuesday, 15 December 2015 at 08:08:10 UTC, landaire wrote:
> - Runnable examples would be *so* useful! They're present on
> the homepage, why can't the examples provided in the inline
> docs be runnable as well?
[snip]
> Here's an imgur album I created to show some suggestions for
> function signatures: http://imgur.com/a/njHKI
These are all great suggestions. Please add them to the bug
report already mentioned in this thread.
> - Dead links = compile error when compiling documentation? This
> was annoying when trying to find out more about OutputRanges.
> The only resource I found was on the std.range page in the tee
> definition, and the link was dead:
> http://dlang.org/phobos/std_range.html#.tee
I think CyberShadow was working on this. It is a problem though
that needs fixing.
> - Link to where the code is implemented in Phobos at the time
> of compilation. e.g. clicking the actual name of "find" could
> link me here:
> https://github.com/D-Programming-Language/phobos/blob/b6a61d9e719a9d680936db44b98fbb5dd28bf6b1/std/algorithm/searching.d#L1498. More than once I found that reading the code was more useful than reading the documentation.
Also a good idea.
More information about the Digitalmars-d
mailing list