Documentation improvements needed for versioning

Andrei Alexandrescu SeeWebsiteForEmail at erdani.com
Tue Nov 2 22:07:19 UTC 2021


I just took a look at various docs generated for

1. The new mismatch does not look good:

http://dtest.dlang.io/artifact/website-5eac54d55eb14787a4e4f8a8054e50f33fe164c1-d81ca42a781e6b8b64a57ee952c8a154/web/phobos-prerelease/std_algorithm_comparison.html#.mismatch

The ddox version is not better:

http://dtest.dlang.io/artifact/website-5eac54d55eb14787a4e4f8a8054e50f33fe164c1-d81ca42a781e6b8b64a57ee952c8a154/web/library-prerelease/std/algorithm/comparison/mismatch.html

Documentation should not mention `canon` etc but instead should expand 
the alias. This is an often-requested feature for ddoc. The template 
constraint looks bad too.

2. The public imports should link to the imported stuff:

http://dtest.dlang.io/artifact/website-5eac54d55eb14787a4e4f8a8054e50f33fe164c1-d81ca42a781e6b8b64a57ee952c8a154/web/phobos-prerelease/std_v2alpha_range_primitives.html

http://dtest.dlang.io/artifact/website-5eac54d55eb14787a4e4f8a8054e50f33fe164c1-d81ca42a781e6b8b64a57ee952c8a154/web/phobos-prerelease/std_v2alpha_meta.html

So probably at a minimum we should have the alias collapsing working for 
ddoc and/or ddox, or switch to adrdox. A solution would be beneficial 
regardless to the solution ultimately chosen for v2.


More information about the Digitalmars-d mailing list