Skip to content

Commit

Permalink
Fix(doc): ClientResponse.release should be a instance method, not a c…
Browse files Browse the repository at this point in the history
…oroutine in the doc (#5835)
  • Loading branch information
Hanaasagi authored Jun 29, 2021
1 parent 10995e8 commit d55728d
Show file tree
Hide file tree
Showing 2 changed files with 3 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`.
4 changes: 2 additions & 2 deletions docs/client_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1225,7 +1225,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 @@ -1354,7 +1354,7 @@ Response object

.. seealso:: :meth:`close`, :meth:`release`.

.. comethod:: release()
.. method:: release()

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 d55728d

Please sign in to comment.