Add docs for ctx managers #3907
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Bibo-Joshi
reviewed
Oct 1, 2023
Member
Bibo-Joshi
left a comment
Bibo-Joshi
left a comment
There was a problem hiding this comment.
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?
added 4 commits
October 2, 2023 19:23
…am-bot into add-ctxmanager-docstring
harshil21
reviewed
Oct 5, 2023
Bibo-Joshi
approved these changes
Oct 9, 2023
Member
Bibo-Joshi
left a comment
Bibo-Joshi
left a comment
There was a problem hiding this comment.
Thanks for the updates! :)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #3886
I wonder if we should add docstring for args in
__aexit__?