u/mlg/2025-11-19/md-links: update advice on html#44
Merged
Conversation
timj
approved these changes
Nov 20, 2025
timj
left a comment
timj
left a comment
Member
There was a problem hiding this comment.
Great. Thank you. A policy of use markdown if markdown supports what you need is going to help a lot.
| Line breaks | ||
| ^^^^^^^^^^^ | ||
|
|
||
| Avoid ``html`` format line breaks ``<br>`` in favor of two spaces at the end of the line. |
Member
There was a problem hiding this comment.
A \ at the end of the line might work as well if the editors strip trailing white space.
Contributor
Author
There was a problem hiding this comment.
Oh that does work, nice -- and it's a less ambiguous indicator that the author wants a line break. The pre-commit doesn't strip trailing whitespace in markdown (not now, anyway) but a \ seems more future-proof, too. I changed the advice and also the template.ipynb to use \ for line breaks, not double spaces, thanks.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.