Skip to content

Commit

Permalink
[PR #5835 backport][3.9] Fix(doc): ClientResponse.release (#7554)
Browse files Browse the repository at this point in the history
## What do these changes do?
Backport changes from #5835 to the `3.9` branch.
`ClientResponse.release` should be marked as method not coroutine.

Co-authored-by: 秋葉 <ambiguous404@gmail.com>
  • Loading branch information
cdce8p and Hanaasagi authored Aug 26, 2023
1 parent b9b0906 commit e9b918b
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGES/5836.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix the `ClientResponse.release`'s type in the doc. Change from `comethod` to `method`.
3 changes: 1 addition & 2 deletions docs/client_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1274,7 +1274,7 @@ Response object
assert resp.status == 200

After exiting from ``async with`` block response object will be
*released* (see :meth:`release` coroutine).
*released* (see :meth:`release` method).

.. attribute:: version

Expand Down Expand Up @@ -1405,7 +1405,6 @@ Response object
.. seealso:: :meth:`close`, :meth:`release`.

.. method:: release()
:async:

It is not required to call `release` on the response
object. When the client fully receives the payload, the
Expand Down

0 comments on commit e9b918b

Please sign in to comment.