Fix markdown list in docstring #1111
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
Trailing content is unindented, so the renderer reads the markdown list as fragmented. Indent the enclosed content by 2 spaces. Also dedent the lead sentences, so that there's less space to cover for trailing content. Thus, they don't get picked up as code by some other renderers.
|
The checks seem to be failing because there isn't a name |
avik-pal
approved these changes
Dec 3, 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.
Trailing content is unindented, so the renderer reads the markdown list as fragmented. Indent the enclosed content by 2 spaces. Also dedent the lead sentences, so that there's less space to cover for trailing content. Thus, they don't get picked up as code by some other renderers.