You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Support PEP 702 to register deprecations with autdoc #11963
Is your feature request related to a problem? Please describe.
I am currently using PEP 702 to mark functions and classes as deprecated in Python, like this:
fromtyping_extensionsimportdeprecated@deprecated("This function isn't used anymore. Instead use XYZ")deff(): pass
However, that information does not show up in sphinx when I autodoc the functions/classes, so users are not aware that they are from looking at the docs.
Describe the solution you'd like
It would be great if the deprecated directive would be added to classes, functions, and overloaded functions that are tagged with this decorator.
Describe alternatives you've considered
Instead, for now I can manually add that to the docstring as well.
Activity
[-]Support PEP 702 to register deprecations with autdo[/-][+]Support PEP 702 to register deprecations with autdoc[/+]