Do not accept footnote definitions with line breaks #125
Conversation
This change brings commonmark-hs into alignment with [markdown-it] and hugo/goldmark. It's close to GitHub, but GitHub [doesn't parse the backslashes as hard line breaks][gist]. It's odd that link reference definitions are allowed to have line breaks and footnote definitions aren't, but it's not worth it to be gratuitously different. [markdown-it]: https://markdown-it.github.io/#md3=%7B%22source%22%3A%22%5B%5Efoo%5C%5C%5Cnbar%5D%3A%20not%20a%20footnote%20definition%5Cn%5Cn%5Bbaz%5C%5C%5Cnquux%5D%3A%20https%3A%2F%2Frust-lang.org%5Cn%5Cn%5Bfirst%5Cnsecond%5D%3A%20https%3A%2F%2Frust-lang.org%5Cn%5Cn%5B%5Ethird%5Cnfourth%5D%3A%20not%20a%20footnote%20definition%5Cn%5Cn%5Bbaz%5C%5C%5Cnquux%5D%5Cn%5B%5Efoo%5C%5C%5Cnbar%5D%5Cn%5Bfirst%5Cnsecond%5D%5Cn%5B%5Ethird%5Cnfourth%5D%22%2C%22defaults%22%3A%7B%22html%22%3Afalse%2C%22xhtmlOut%22%3Afalse%2C%22breaks%22%3Afalse%2C%22langPrefix%22%3A%22language-%22%2C%22linkify%22%3Atrue%2C%22typographer%22%3Atrue%2C%22_highlight%22%3Atrue%2C%22_strict%22%3Afalse%2C%22_view%22%3A%22html%22%7D%7D [gist]: https://gist.github.com/notriddle/7fd2410a2585123ad0f894b08c58b21f
notriddle
force-pushed
the
notriddle/footnote-paragraph-break
branch
from
49a6b88 to
fc30da2
Compare
|
I'm tempted to think we should allow line breaks but normalize the labels, just as we do for reference links. Pandoc also doesn't allow line breaks in note labels, but I can't recall whether there's a reason. I never put spaces in these, myself, but if I did, there'd be a chance the document would break when reformatted, if the space turned to a newline. |
|
Pipe table cells can't have line breaks in them, so a working autoformatter needs to know about these extensions anyway. |
|
That's true, but footnote labels and link labels are so alike that it complicates the reader/writer's mental model to have to keep in mind this distinction. |
|
I think we can merge this now (disallowing newlines altogether is better than allowing blank lines), but I am not completely happy with the no newlines thing and might want to revisit that. |
Fixes #124
This change brings commonmark-hs into alignment with markdown-it and hugo/goldmark. It's close to GitHub, but GitHub doesn't parse the backslashes as hard line breaks.
It's odd that link reference definitions are allowed to have line breaks and footnote definitions aren't, but it's not worth it to be gratuitously different.