Was just looking over these:

https://dlang.org/library-prerelease/std/experimental/checkedint.html
https://dlang.org/phobos-prerelease/std_experimental_checkedint.html
http://dpldocs.info/experimental-docs/std.experimental.checkedint.html

There are a few issues I found with the ddox-based library:

* There's code coloring in inline code, which is a bit distracting. Syntax highlighting should be ideally limited to code blocks.

* For some reason tables have the wrong penalties set up because they hyphenate type names in their left column (e.g. Pro-erCom-pare) which makes all tables look comically bad.

* Sometimes there is a space between "Checked" and "!" when the combination appears in running text. Other type names (such as Abort) also have an extra space following them in running text.

* The second table not only hyphenates its left column awkardly, but also overlays onOverflow on top of text in the next column.

* The headers "Author" and "License" appear even though they have no content. Clearly this could be fixed easily, but my understanding is that a great advantage of ddox over ddoc is its programmability, which should make it easy to make such adjustments.

The ddox documentation with its page-per-artifact approach continues to hold good promise, but it has been one week of work away from becoming the default for literally years now. It really needs some TLC. Who wants to volunteer?


Thanks,

Andrei

Reply via email to