Skip to content

[ty] Render Google and NumPy docstrings as Markdown#25697

Draft
lerebear wants to merge 3 commits into
lerebear/push-usmovrotyxzmfrom
lerebear/push-docstring-markdown-styles
Draft

[ty] Render Google and NumPy docstrings as Markdown#25697
lerebear wants to merge 3 commits into
lerebear/push-usmovrotyxzmfrom
lerebear/push-docstring-markdown-styles

Conversation

@lerebear

@lerebear lerebear commented Jun 6, 2026

Copy link
Copy Markdown
Contributor

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.

@astral-sh-bot astral-sh-bot Bot added server Related to the LSP server ty Multi-file analysis & type inference labels Jun 6, 2026
@lerebear lerebear force-pushed the lerebear/push-usmovrotyxzm branch from 2457086 to 5a278d4 Compare June 6, 2026 05:41
@lerebear lerebear force-pushed the lerebear/push-docstring-markdown-styles branch 3 times, most recently from a68f2e3 to 029a217 Compare June 6, 2026 05:57
@lerebear lerebear force-pushed the lerebear/push-usmovrotyxzm branch from 5a278d4 to cc76109 Compare June 7, 2026 05:51
@lerebear lerebear force-pushed the lerebear/push-docstring-markdown-styles branch from 029a217 to 1271224 Compare June 7, 2026 06:08
@lerebear lerebear force-pushed the lerebear/push-usmovrotyxzm branch from cc76109 to 8ba764b Compare June 7, 2026 06:18
@lerebear lerebear force-pushed the lerebear/push-docstring-markdown-styles branch from 1271224 to b3d6e2e Compare June 7, 2026 06:20
@lerebear lerebear force-pushed the lerebear/push-usmovrotyxzm branch from 8ba764b to 620dd12 Compare June 7, 2026 06:34
@lerebear lerebear force-pushed the lerebear/push-docstring-markdown-styles branch from b3d6e2e to 3a8b890 Compare June 7, 2026 06:34
@codspeed-hq

codspeed-hq Bot commented Jun 7, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 67 untouched benchmarks
⏩ 60 skipped benchmarks1


Comparing lerebear/push-docstring-markdown-styles (b61f96a) with lerebear/push-usmovrotyxzm (cba0858)

Open in CodSpeed

Footnotes

  1. 60 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@lerebear lerebear force-pushed the lerebear/push-usmovrotyxzm branch from 620dd12 to e180f4f Compare June 7, 2026 07:52
@lerebear lerebear force-pushed the lerebear/push-docstring-markdown-styles branch 4 times, most recently from 28bc887 to c976dc2 Compare June 7, 2026 20:54
@lerebear lerebear force-pushed the lerebear/push-usmovrotyxzm branch from e180f4f to f493906 Compare June 7, 2026 21:08
@lerebear lerebear force-pushed the lerebear/push-docstring-markdown-styles branch 11 times, most recently from 020e9f1 to 424bf4d Compare June 8, 2026 05:44
@lerebear lerebear force-pushed the lerebear/push-docstring-markdown-styles branch 9 times, most recently from f0ae92a to a8e65a8 Compare June 8, 2026 20:22
@lerebear lerebear force-pushed the lerebear/push-usmovrotyxzm branch 2 times, most recently from 929a7ce to e5eff18 Compare June 8, 2026 21:42
@lerebear lerebear force-pushed the lerebear/push-docstring-markdown-styles branch from a8e65a8 to c6a48b2 Compare June 8, 2026 21:50
@lerebear lerebear force-pushed the lerebear/push-usmovrotyxzm branch 2 times, most recently from 72125d0 to 252f51a Compare June 8, 2026 22:00
@lerebear lerebear force-pushed the lerebear/push-docstring-markdown-styles branch from c6a48b2 to c9c1115 Compare June 8, 2026 22:02
@lerebear lerebear force-pushed the lerebear/push-usmovrotyxzm branch from 252f51a to ee5dbb4 Compare June 8, 2026 22:11
@lerebear lerebear force-pushed the lerebear/push-docstring-markdown-styles branch 2 times, most recently from 533eb63 to f0d4758 Compare June 9, 2026 00:26
@lerebear lerebear force-pushed the lerebear/push-docstring-markdown-styles branch from f0d4758 to d9710a0 Compare June 9, 2026 04:16
@lerebear lerebear force-pushed the lerebear/push-usmovrotyxzm branch from ee5dbb4 to cba0858 Compare June 9, 2026 04:16
@lerebear lerebear force-pushed the lerebear/push-docstring-markdown-styles branch from d9710a0 to b61f96a Compare June 9, 2026 04:26
@lerebear lerebear force-pushed the lerebear/push-usmovrotyxzm branch from cba0858 to d42cf77 Compare June 9, 2026 04:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

server Related to the LSP server ty Multi-file analysis & type inference

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant