clot27 · GitHub

@clot27

Copy link Copy Markdown

Member

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

Aditya

@clot27

harshil21

Copy link Copy Markdown

Member

Choose a reason for hiding this comment

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

docstring nitpicks mostly:

Aditya

Bibo-Joshi

Copy link Copy Markdown

Member

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?

Aditya added 4 commits

October 2, 2023 19:23

Aditya

Aditya

…am-bot into add-ctxmanager-docstring

Aditya

Aditya

harshil21

Aditya

Bibo-Joshi

Copy link Copy Markdown

Member

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

Closed

Read the original on github.com ↗