Markdown linting: spacing around ordered lists #5323
Conversation
| @@ -285,7 +285,7 @@ There are 3 ways to define what data to use for the consistent hash key. | |||
| }); | |||
| ``` | |||
|
|
|||
| 2. The messages may implement `IConsistentHashable`. The key is part of the message and it's convenient to define it together with the message definition. | |||
| 1. The messages may implement `IConsistentHashable`. The key is part of the message and it's convenient to define it together with the message definition. | |||
There was a problem hiding this comment.
I don't really quite get this, I know that markdown automatically renumber the numbered list, but as someone who actually writes documentation, its less confusing to use the actual used number instead of repeating 1. all the time
There was a problem hiding this comment.
@Arkatufus in case a numbered item moves in a list, it's helpful to not have to manually re-number.
Markdownlint actually does allow you to specify one style (default, in this PR) or ordered style if you'd prefer. Bigger key is to ensure consistency. I chose one style because it is the default but also because I like the idea of thinking of OLs the same as ULs and using one symbol for a list item while I'm authoring.
If there's a strong preference here, I can change the style in the config files to specify ordered style, but for consistency's sake I'd recommend the default approach taken in this PR for now.
There was a problem hiding this comment.
See markdownlint/markdownlint#392 for additional input
Supports #5312.
Rules in this PR: