-
-
Notifications
You must be signed in to change notification settings - Fork 196
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.
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
Support for typing @overload annotation #442
Comments
pdoc heavily relies on dynamic analysis. As far as I know, you cannot access |
I see. That makes sense. Do you by chance know about any documentation tool that supports both typestubs and overloads 😅 It is surprisingly hard to find. Btw: It might be possible starting from 3.11. |
Seems like this hasn't made it into 3.11 in time and will be in 3.12 the earliest.
I don't know, but Sphinx and maybe mkdocstrings have the largest ecosystems. |
Yes, not in the Anyway, I give up for now and will revisit the whole thing in the very distant future again. (Sphinx autosummary/doc does not support type stubs at all and overloads only via docstrings and without descriptions of each overload). Thanks for considering! |
Problem Description
Some support for function overloads specified by
@overload
annotation in typestubs is missing. All functions that have it, are just shown with the general base implementation(*args, **kwds)
instead of the declared and fully typed overloads.Proposal
In the beginning, just one entry per overload would be nice.
Additional context
Trying to document a Cython extension that due to its C++ origin has typestubs with
@overload
annotationsThe text was updated successfully, but these errors were encountered: