[ty] Render Google and NumPy docstrings as Markdown#25697
Draft
lerebear wants to merge 3 commits into
Draft
Conversation
2457086 to
5a278d4
Compare
a68f2e3 to
029a217
Compare
5a278d4 to
cc76109
Compare
029a217 to
1271224
Compare
cc76109 to
8ba764b
Compare
1271224 to
b3d6e2e
Compare
8ba764b to
620dd12
Compare
b3d6e2e to
3a8b890
Compare
Merging this PR will not alter performance
Comparing Footnotes
|
620dd12 to
e180f4f
Compare
28bc887 to
c976dc2
Compare
e180f4f to
f493906
Compare
020e9f1 to
424bf4d
Compare
f0ae92a to
a8e65a8
Compare
929a7ce to
e5eff18
Compare
a8e65a8 to
c6a48b2
Compare
72125d0 to
252f51a
Compare
c6a48b2 to
c9c1115
Compare
252f51a to
ee5dbb4
Compare
533eb63 to
f0d4758
Compare
f0d4758 to
d9710a0
Compare
ee5dbb4 to
cba0858
Compare
d9710a0 to
b61f96a
Compare
cba0858 to
d42cf77
Compare
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
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
Render supported Google and NumPy docstring sections as Markdown for hover and related IDE output. This routes docstrings through a narrow structured-docstring parser after the existing reST rendering pass, covering top-level Parameters/Attributes/Returns/Raises sections while leaving existing parameter-documentation extraction unchanged.
Closes astral-sh/ty#1667
Test Plan
Please see included tests.