Conversation
The LREFs were broken. Could fix that with underscores, but the links would just point back at the current section. There's no point in having such links.
std/algorithm/sorting.d
Outdated
| less). | ||
|
|
||
| Unlike $(LREF isSorted), $(LREF isStrictlyMonotonic) does not allow for equal values, | ||
| Unlike isSorted, isStrictlyMonotonic does not allow for equal values, |
There was a problem hiding this comment.
They'd still need to be in code format.
There was a problem hiding this comment.
They'd still need to be in code format.
Isn't auto-highlighting enough? If these two need a monospaced font, then all auto-highlighted symbols need a monospaced font, no?
There was a problem hiding this comment.
Well anything that's not part of the English prose needs to be formatted differently. This is code so it should come out in code font by whichever means. N.B. "isSorted" is not even in the dictionary.
There was a problem hiding this comment.
Oh I see what you mean. Yes, it would be best if whatever is highlighted would come in code font.
There was a problem hiding this comment.
Yes, it would be best if whatever is highlighted would come in code font.
PR to use <code> tags for auto-highlights, resulting in monospaced font: dlang/dlang.org#1516
There was a problem hiding this comment.
What's auto-highlighting and why doesn't ddox have it as well?
Didn't ddox automatically detect symbols in the past?
There was a problem hiding this comment.
What's auto-highlighting
Ddoc recognizes and highlights certain words in prose (keywords, the symbol being documented, parameters). I call that auto-highlighting, as opposed to doing it manually with $(D ...) or backticks. Auto-highlighting is a common source of broken links, because it happens in URLs too (as happened here).
and why doesn't ddox have it as well?
Didn't ddox automatically detect symbols in the past?
DDOX does some auto-linking of symbols, but I'm not sure how it detects them. I don't think it ever searched for the symbol that's being documented or its parameters to highlight them, like Ddoc does.
DDOX not doing auto-highlighting is a problem which I didn't have on my radar. There should be consistency across Ddoc and DDOX. As far as I see, we can either:
- implement auto-highlighting in DDOX, or
- disable auto-highlighting in our Ddoc macros and highlight everything manually.
I'm not up for either of those challenges right now, so I've just added backticks to this PR. So that at least the symbols here are in monospaced font (and auto-linked) on the DDOX pages, too.
DDOX doesn't do auto-highlighting, but the symbols need to be formatted as code there, too.
|
Auto-merge toggled on |
3 participants
The LREFs were broken. Could fix that with underscores, but the links would
just point back at the current section. There's no point in having such
links.