From d55728da7486e0295a11bf2378a2eceb8fe39c64 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=A7=8B=E8=91=89?= Date: Tue, 29 Jun 2021 12:15:40 -0500 Subject: [PATCH] Fix(doc): ClientResponse.release should be a instance method, not a coroutine in the doc (#5835) --- CHANGES/5836.doc | 1 + docs/client_reference.rst | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) create mode 100644 CHANGES/5836.doc diff --git a/CHANGES/5836.doc b/CHANGES/5836.doc new file mode 100644 index 00000000000..ef8909cefb8 --- /dev/null +++ b/CHANGES/5836.doc @@ -0,0 +1 @@ +Fix the `ClientResponse.release`'s type in the doc. Change from `comethod` to `method`. diff --git a/docs/client_reference.rst b/docs/client_reference.rst index 13697a3a718..ed935a2da1a 100644 --- a/docs/client_reference.rst +++ b/docs/client_reference.rst @@ -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 @@ -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