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

Improve documentation for BaseRequest.path and BaseRequest.raw_path #3791

Merged
merged 3 commits into from May 22, 2019

Conversation

@Harmon758
Copy link
Contributor

commented May 22, 2019

What do these changes do?

Fix grammatical mistakes in the documentation for BaseRequest.raw_path and change "quoted" to "URL-encoded" and "unquoted" to "URL-decoded" in the documentation for BaseRequest.path and BaseRequest.raw_path.
The latter change improves the coherence of the documentation, as the term, (un)quoted, can be ambiguous/unclear.

Are there changes in behavior for the user?

No

Related issue number

N/A

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."
Harmon758 added 2 commits May 22, 2019

@Harmon758 Harmon758 requested review from asvetlov and webknjaz as code owners May 22, 2019

@codecov-io

This comment has been minimized.

Copy link

commented May 22, 2019

Codecov Report

Merging #3791 into master will increase coverage by 3.06%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #3791      +/-   ##
==========================================
+ Coverage   94.88%   97.94%   +3.06%     
==========================================
  Files          43       43              
  Lines        8575     8576       +1     
  Branches     1373     1374       +1     
==========================================
+ Hits         8136     8400     +264     
+ Misses        337       74     -263     
  Partials      102      102
Impacted Files Coverage Δ
aiohttp/streams.py 98.2% <0%> (+0.26%) ⬆️
aiohttp/web_urldispatcher.py 99.25% <0%> (+0.29%) ⬆️
aiohttp/helpers.py 97.22% <0%> (+0.75%) ⬆️
aiohttp/connector.py 97.67% <0%> (+1.49%) ⬆️
aiohttp/test_utils.py 99.68% <0%> (+1.9%) ⬆️
aiohttp/frozenlist.py 100% <0%> (+2.12%) ⬆️
aiohttp/http_writer.py 98.11% <0%> (+2.83%) ⬆️
aiohttp/http_parser.py 97.93% <0%> (+4.81%) ⬆️
aiohttp/__init__.py 100% <0%> (+5.55%) ⬆️
aiohttp/web_runner.py 97.92% <0%> (+6.21%) ⬆️
... and 5 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 506c244...fe4b9dd. Read the comment docs.

@asvetlov
Copy link
Member

left a comment

Agree, URL-decoded looks better than quoted

@asvetlov asvetlov merged commit 6b0a651 into aio-libs:master May 22, 2019

4 checks passed

Travis CI - Pull Request Build Passed
Details
WIP Ready for review
Details
codecov/patch Coverage not affected when comparing 506c244...fe4b9dd
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
asvetlov added a commit that referenced this pull request May 22, 2019
[3.5] Improve documentation for BaseRequest.path and BaseRequest.raw_…
…path (#3791)

(cherry picked from commit 6b0a651)

Co-authored-by: Harmon <Harmon758@gmail.com>
asvetlov added a commit that referenced this pull request May 22, 2019
[3.5] Improve documentation for BaseRequest.path and BaseRequest.raw_…
…path (#3791) (#3792)

(cherry picked from commit 6b0a651)

Co-authored-by: Harmon <Harmon758@gmail.com>

@Harmon758 Harmon758 deleted the Harmon758:baserequest-attribute-docs-fixes branch May 22, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.