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
Add docs for ctx managers #3907
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.
docstring nitpicks mostly:
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 your PR! In addition to my below comments:
- I see no added value in documenting the arguments of
__aexit__
, as they are defined by Python itself. If you like to, you can add something likePlease refer to the [Python documentation](https://docs.python.org/3.11/reference/datamodel.html?highlight=__aexit__#object.__aexit__) for information about the accepted arguments
- We have these parts "Instances of this class can be used as asyncio context managers, where …" in the class docstrings of the affected classes. Could you add a "seealso aenter & exit" below these?
…am-bot into add-ctxmanager-docstring
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! :)
closes #3886
I wonder if we should add docstring for args in
__aexit__
?