Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix(doc): ClientResponse.release should be a instance method, not a c… #5835

Merged
merged 1 commit into from
Jun 29, 2021

Conversation

Hanaasagi
Copy link
Member

@Hanaasagi Hanaasagi commented Jun 28, 2021

What do these changes do?

From the doc, https://docs.aiohttp.org/en/stable/client_reference.html?highlight=release#aiohttp.ClientResponse.release

The ClientResponse.release is a coroutine, but in fact it is a instance method in the source code.

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()

Are there changes in behavior for the user?

Only change the doc.

Related issue number

#5836

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> for example (588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

@codecov
Copy link

codecov bot commented Jun 28, 2021

Codecov Report

Merging #5835 (d51f8b2) into master (10995e8) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #5835   +/-   ##
=======================================
  Coverage   96.75%   96.75%           
=======================================
  Files          44       44           
  Lines        9849     9849           
  Branches     1591     1591           
=======================================
  Hits         9529     9529           
  Misses        182      182           
  Partials      138      138           
Flag Coverage Δ
unit 96.64% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 10995e8...d51f8b2. Read the comment docs.

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Jun 28, 2021
@Hanaasagi Hanaasagi marked this pull request as ready for review June 28, 2021 07:58
@Dreamsorcerer Dreamsorcerer merged commit d55728d into aio-libs:master Jun 29, 2021
@Hanaasagi Hanaasagi deleted the fix-doc branch June 29, 2021 18:18
cdce8p pushed a commit to cdce8p/aiohttp that referenced this pull request Aug 25, 2023
Dreamsorcerer pushed a commit that referenced this pull request Aug 26, 2023
## 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: 秋葉 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot:chronographer:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants