Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Markdown documentation generation: do not insert line breaks #1879

Merged
merged 1 commit into from
Apr 3, 2024
Merged

Markdown documentation generation: do not insert line breaks #1879

merged 1 commit into from
Apr 3, 2024

Commits on Apr 3, 2024

  1. doc generation: do not insert line breaks 

    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 #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.
    @yannham
    yannham committed Apr 3, 2024
    Configuration menu
    Copy the full SHA
    2cd8bf8 View commit details
    Browse the repository at this point in the history