Simple step to making Ddoc better

Sönke Ludwig via Digitalmars-d digitalmars-d at puremagic.com
Fri Dec 18 08:57:44 PST 2015


Am 18.12.2015 um 17:48 schrieb Adam D. Ruppe:
> On Friday, 18 December 2015 at 16:42:14 UTC, Sönke Ludwig wrote:
>> * Currently it looks at all words in a text to find symbols, but once
>> the documentation is adjusted accordingly, it would be switched to
>> just look within `code` or $(D code) parts.
>
> What about examples and prototypes?

It does that, too, forgot to mention that.

> That reminds me, formatting the prototypes I think is high value too.
> DDox does ok:
>
> https://dlang.org/library/std/algorithm/comparison/levenshtein_distance.html
>
>
> But I still think we can do a lot better.

Agreed, do you have concrete ideas? One thing that could also be 
interesting (and easy to do) would be to add parameter names in the 
"Functions" overview tables, so that levenshteinDistance gets listed as 
levenshteinDistance(equals, s, t). That could replace the manually 
authored cheat sheet in many cases.


More information about the Digitalmars-d mailing list