Skip to content

Make it easy to use types from _typeshed in docstrings #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
lagru opened this issue May 21, 2025 · 0 comments · May be fixed by #56
Open

Make it easy to use types from _typeshed in docstrings #42

lagru opened this issue May 21, 2025 · 0 comments · May be fixed by #56
Labels
enhancement New feature or request
Milestone
v0.4

Comments

@lagru
Copy link
Member

lagru commented May 21, 2025

Certain types are only available via Python's _typeshed module, e.g., DataclassInstance. It would be nice if you could use these out of the box in Docstrings.

Adding this feature will involve figuring out how to get a list the types in the _typeshed into docstub. One problem is, that they aren't available at runtime...
@lagru lagru added the enhancement New feature or request label May 21, 2025
@lagru lagru changed the title Make it easy to use _typeshed Make it easy to use types from _typeshed in docstrings May 21, 2025
@lagru lagru added this to the v0.4 milestone May 25, 2025
@lagru lagru linked a pull request May 27, 2025 that will close this issue
Draft
@lagru lagru linked a pull request May 27, 2025 that will close this issue
Attempt to statically collect types in typeshed (ahead of time) #56
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
v0.4
Development

Successfully merging a pull request may close this issue.

Attempt to statically collect types in typeshed (ahead of time) scientific-python/docstub
1 participant
@lagru