Simplify the hello world example, explain request lifecycle #4329
Conversation
Simplify the hello world example in the README and doc index Add a new page to the doc (http_request_lifecycle) to explain why aiohttp's client API requires several steps for performing a request. Compare it with the "requests" library. Gives some information about the use of the ClientSession object.
psf-chronographer
bot
added
the
bot:chronographer:provided
README.rst
Outdated
|
|
||
| Comming from `requests<https://requests.readthedocs.io/>`_ ? Read :ref:`why we need so many lines <http://aiohttp.readthedocs.io/en/latest/aiohttp-request-lifecycle>`. |
CONTRIBUTORS.txt
Outdated
| @@ -125,6 +125,7 @@ Igor Pavlov | |||
| Ilya Chichak | |||
| Ingmar Steen | |||
| Ivan Larin | |||
| Kevin Samuel | |||
There was a problem hiding this comment.
"K" goes after "J" in the alphabet.
Codecov Report
@@ Coverage Diff @@
## master #4329 +/- ##
==========================================
- Coverage 97.55% 97.51% -0.04%
==========================================
Files 43 43
Lines 8862 8859 -3
Branches 1389 1389
==========================================
- Hits 8645 8639 -6
- Misses 93 96 +3
Partials 124 124
Continue to review full report at Codecov.
|
|
I see that the coverage went down, but I didn't touched the code or unit tests. Maybe I'm doing the PR on the wrong branch? |
There was a problem hiding this comment.
Awesome!
I very appreciate the PR, it elaborates the idea of the client session pretty well.
One minor thing: please use double backticks for inline code examples.
aiohttp follows CPython style guide for documentation, it contains a rule for code formatting.
|
Coverage jittering for aiohttp worries me too. |
|
Thanks! |
) (cherry picked from commit 17bed45) Co-authored-by: ksamuel <[email protected]>
) (#4335) (cherry picked from commit 17bed45) Co-authored-by: ksamuel <[email protected]>
What do these changes do?
Simplify the hello world example in the README and doc index
Add a new page to the doc (http_request_lifecycle) to explain why aiohttp's client API requires several steps for performing a request. Compare it with the "requests" library. Gives some information about the use of the ClientSession object.
Are there changes in behavior for the user?
No
Related issue number
Close #4272
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.