-
Notifications
You must be signed in to change notification settings - Fork 122
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
docs: update docstrings with deprecated directive #1178
docs: update docstrings with deprecated directive #1178
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, thanks!
What do you & @benhoyt think about putting a deprecation notice on OpenedPort
here as well? With a message to use Port
instead, and the version either 2.13 as an official deprecation or 2.7 which is when it essentially was?
A deprecation notice on |
It seems if I add a docstring on a global variable:
it does not show up in sphinx autodoc.
|
….com:IronCore864/operator into update-docstring-to-use-deprecated-directive
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the updates!
Update docstrings to use sphinx
deprecated
directive.