docs: Fix list formatting in changelog for v5.1.0 #771
Conversation
This file contains 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
The list of changes was not indented enough, and so didn't actually get formatted as a list when rendering HTML, which left it pretty unreadable. This also adds a blank line between the last 4.x version and 5.0.0 to match the extra blank lines between other major versions.
This matches the project's `.editorconfig` rules.
Mr0grog
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is really just a typo fix. I noticed that the changelog for v5.1.0 is getting rendered as a paragraph instead of a list because it wasn't indented enough:
This change just fixes the indentation so it renders as a list:
While I was at it I removed dangling spaces at the end of lines in the changelog (actually my editor just did this automatically, since it’s in the project’s
.editorconfigfile) and added a blank line between the latest 4.x release and 5.0.0, since all the other major versions have extra blank lines between them.