Improve documentation for BaseRequest.path and BaseRequest.raw_path #3791
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ 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
Continue to review full report at Codecov.
|
asvetlov
approved these changes
May 22, 2019
asvetlov
pushed a commit
that referenced
this pull request
May 22, 2019
…path (#3791) (cherry picked from commit 6b0a651) Co-authored-by: Harmon <[email protected]>
asvetlov
added a commit
that referenced
this pull request
May 22, 2019
…path (#3791) (#3792) (cherry picked from commit 6b0a651) Co-authored-by: Harmon <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What do these changes do?
Fix grammatical mistakes in the documentation for
BaseRequest.raw_pathand change "quoted" to "URL-encoded" and "unquoted" to "URL-decoded" in the documentation forBaseRequest.pathandBaseRequest.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
CONTRIBUTORS.txtCHANGESfolder<issue_id>.<type>for example (588.bugfix)issue_idchange it to the pr id after creating the pr.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.