Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc generation: do not insert line breaks (tweag#1879)
The code generating markdown documentation from a Nickel configuration used to unconditionally insert hard line breaks between a field's signature and the rest of its documentation. However, one can't insert a hard line break immediately followed by a blocks in commonmark (or put differently: it's not representable as a source), and those line breaks were just rendered as spurious backslashes at best, or sometimes interpreted differently (see tweag#1706 for more details). A bit of experimentation showed that what comes after this line break is always a block in the sense of commonmark (even when it's simple documentation text, it's wrapped as a Markdown paragraph). Thus this commit just removes the line break altogether, which is not useful and never legal anyway.
- Loading branch information