[ty] Improve rendering of ReST directives in docstrings#22512
Merged
AlexWaygood merged 2 commits intoastral-sh:mainfrom Jan 14, 2026
Merged
[ty] Improve rendering of ReST directives in docstrings#22512AlexWaygood merged 2 commits intoastral-sh:mainfrom
AlexWaygood merged 2 commits intoastral-sh:mainfrom
Conversation
Signed-off-by: Aryan Bagade <[email protected]>
AryanBagade
requested review from
AlexWaygood,
Gankra,
MichaReiser,
carljm,
dcreager and
sharkdp
as code owners
AlexWaygood
added
server
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
3 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.
Summary
Improves the rendering of ReST version directives in docstrings to use human-readable phrases matching Sphinx/Pylance output.
Before:
**version-added:** *3.0***version-changed:** *4.0***deprecated:** *1.2.3*After:
**Added in version 3.0:****Changed in version 4.0:****Deprecated since version 1.2.3:**Mapping follows Sphinx's documentation:
versionadded/version-added→ "Added in version"versionchanged/version-changed→ "Changed in version"deprecated/version-deprecated→ "Deprecated since version"versionremoved/version-removed→ "Removed in version"Fixes astral-sh/ty#2147
Test Plan
version_blocks,deprecated_prefix_gunk)cargo clippypasses with no warnings