os: format readme, fix markdown inside html #21286
Merged
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
ttytm
changed the title
|
In terms of a "fix" the PR will not be required anymore after #21287 (comment). If desired, the formatting here can still be done for the sake of formatting. |
spytheman
approved these changes
Apr 15, 2024
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.
Auto-formats the os modules readme. Doing so it fixes an issue with markdown inside html tags.
The formatting changes match with what is used for the bigger part other markdown files in the codebase.
Following commonmarks recommended formatting for markdown inside html tags works here as a fix. Stackoverflow answer with link to commonmark example: https://stackoverflow.com/a/29378250
Putting markdown immediately after a tag never works(at least as far as I know). It even breaks highlighting in the example below. It can work to have a tag immediately after markdown. The latter stopped working for vdoc after the recent fixes regarding indentation and escape characters. The recommended way is to keep a line-break before and after tags. Maybe following recommended commonmark formatting (which is applied by markdown formatters) is good enough as a fix now.