-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Wrong documentation about ClientResponse.release #5836
Copy link
Copy link
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Describe the bug
The ClientResponse.release is a coroutine, but in fact it is a instance method in the source code.
aiohttp/aiohttp/client_reqrep.py
Lines 906 to 918 in 10995e8
| def release(self) -> Any: | |
| if not self._released: | |
| self._notify_content() | |
| if self._closed: | |
| return noop() | |
| self._closed = True | |
| if self._connection is not None: | |
| self._connection.release() | |
| self._connection = None | |
| self._cleanup_writer() | |
| return noop() |
To Reproduce
.
Expected behavior
.. method:: release()
Logs/tracebacks
noPython Version
$ python --version
Python 3.9.1+aiohttp Version
$ python -m pip show aiohttp
Name: aiohttp
Version: 3.7.4
Summary: Async http client/server framework (asyncio)
Home-page: https://github.com/aio-libs/aiohttp
Author: Nikolay Kim
Author-email: [email protected]
License: Apache 2
Location: /root/aiohttp
Requires: attrs, chardet, multidict, async-timeout, yarl, typing-extensions
Required-by:multidict Version
$ python -m pip show multidict
Name: multidict
Version: 5.1.0
Summary: multidict implementation
Home-page: https://github.com/aio-libs/multidict
Author: Andrew Svetlov
Author-email: [email protected]
License: Apache 2
Location: /root/py39/lib/python3.9/site-packages
Requires:
Required-by: yarl, aiohttpyarl Version
$ python -m pip show yarl
Name: yarl
Version: 1.6.3
Summary: Yet another URL library
Home-page: https://github.com/aio-libs/yarl/
Author: Andrew Svetlov
Author-email: [email protected]
License: Apache 2
Location: /root/py39/lib/python3.9/site-packages
Requires: multidict, idna
Required-by: aiohttpOS
Linux 5.10.0-7-amd64 #1 SMP Debian 5.10.40-1 (2021-05-28) x86_64 GNU/Linux
Related component
Client
Additional context
No response
Code of Conduct
- I agree to follow the aio-libs Code of Conduct
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation