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 "Usage" docstring of aiohttp.client.request #4604

Merged
merged 2 commits into from
Mar 19, 2020

Conversation

wereii
Copy link
Contributor

@wereii wereii commented Feb 28, 2020

What do these changes do?

Fix wrong "Usage" of aiohttp.client.request's docstring (function returns context manager).

Are there changes in behavior for the user?

Better, reflecting docstring!

Related issue number

Fixes #4603

Checklist

  • I think the code is well written (N/A)
  • Unit tests for the changes exist (N/A)
  • 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."

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Feb 28, 2020
@wereii wereii changed the title Fix docstring client request Fix "Usage" docstring of aiohttp.client.request Feb 28, 2020
@wereii wereii marked this pull request as ready for review February 28, 2020 19:53
@codecov-io
Copy link

codecov-io commented Feb 28, 2020

Codecov Report

Merging #4604 into master will not change coverage by %.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #4604   +/-   ##
=======================================
  Coverage   97.57%   97.57%           
=======================================
  Files          43       43           
  Lines        8907     8907           
  Branches     1404     1404           
=======================================
  Hits         8691     8691           
  Misses         96       96           
  Partials      120      120           

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 91963c0...0246dd9. Read the comment docs.

@webknjaz webknjaz merged commit 693ed0c into aio-libs:master Mar 19, 2020
@wereii wereii deleted the fix_docstring_client_request branch March 20, 2020 07:52
asvetlov pushed a commit that referenced this pull request Oct 16, 2020
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.

Docstring inaccurate; aiohttp.client.request
3 participants