Skip to content
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

Merged
merged 7 commits into from Oct 9, 2023
Merged

Add docs for ctx managers #3907

merged 7 commits into from Oct 9, 2023

Conversation

clot27
Copy link
Member

@clot27 clot27 commented Sep 29, 2023

closes #3886
I wonder if we should add docstring for args in __aexit__?

Copy link
Member

@harshil21 harshil21 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docstring nitpicks mostly:

docs/source/conf.py Outdated Show resolved Hide resolved
telegram/_bot.py Outdated Show resolved Hide resolved
telegram/_bot.py Outdated Show resolved Hide resolved
telegram/_bot.py Outdated Show resolved Hide resolved
telegram/_bot.py Outdated Show resolved Hide resolved
telegram/_bot.py Outdated Show resolved Hide resolved
telegram/_bot.py Outdated Show resolved Hide resolved
Copy link
Member

@Bibo-Joshi Bibo-Joshi left a 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 like Please 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?

docs/source/conf.py Outdated Show resolved Hide resolved
telegram/_bot.py Outdated Show resolved Hide resolved
docs/source/conf.py Outdated Show resolved Hide resolved
telegram/_bot.py Outdated Show resolved Hide resolved
Copy link
Member

@Bibo-Joshi Bibo-Joshi left a 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! :)

@Bibo-Joshi Bibo-Joshi merged commit af130ef into master Oct 9, 2023
23 checks passed
@Bibo-Joshi Bibo-Joshi deleted the add-ctxmanager-docstring branch October 9, 2023 16:59
@github-actions github-actions bot locked and limited conversation to collaborators Oct 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Documentation]: Context manager dunder Methods
3 participants