[ty] improve indented codefence rendering in docstrings#22408
Merged
Conversation
Gankra
requested review from
AlexWaygood,
MichaReiser,
carljm,
dcreager and
sharkdp
as code owners
Gankra
added
server
Contributor
Author
|
We are now entering the "Aria creates a non-standard dialect of markdown" era of Astral. |
Contributor
Author
|
I would be perfectly fine with the conclusion being "the user isn't allowed to do that" but idk it seems sensible..? |
MichaReiser
reviewed
Jan 6, 2026
Comment on lines
+1286
to
+1294
| Returns: | ||
| Some details | ||
| ~~~~~~python | ||
| x_y = thing_do(); | ||
| ~~~ # this should't close the fence! | ||
| a_b = other_thing(); | ||
| ~~~~~~ | ||
| And so on. | ||
| "); |
Member
There was a problem hiding this comment.
Can you share a screenshot for how e.g. VS Code renders this markdown?
MichaReiser
approved these changes
Jan 6, 2026
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.
By stripping leading indents from codefence lines to ensure they're properly understood by markdown (but otherwise preserving the indent in the codeblock so all the code renders roughly at the right indent).
As described in this comment this solution is very "do what I mean" for when a user has an explicit markdown codeblock in e.g. a
Returns:section which "has" to be indented but that indent makes the verbatim codefence invalid markdown.