gh-102327: Extend docs for "url" and "headers" parameters to HTTPConnection.request()#102328
gh-102327: Extend docs for "url" and "headers" parameters to HTTPConnection.request()#102328Mariatta merged 9 commits into
Conversation
a7cc220 to
86275f8
Compare
April 4, 2023 23:07
|
Looks good overall, I think this provides clarity to the doc. One comment, and I'm being nitpicky here, can we use a different URL in the example, instead of xkcd? Can we use python.org as example? Or other Python-related website. |
Sorry, something went wrong.
Sure. I'll tentatively put in: https://docs.python.org/3/ That URL satisfies the following useful conditions:
|
Sorry, something went wrong.
|
What do you think of moving the doc for The example could be kept at the end, after the documentation of each parameter. |
Sorry, something went wrong.
|
@merwok , makes sense. I'll plan to integrate those revisions later today. |
Sorry, something went wrong.
Sorry, something went wrong.
merwok
left a comment
There was a problem hiding this comment.
This looks pretty great now!
Thanks for the screenshots. Note that pull requests have automatic preview websites for docs, which are even better to see results easily (although sometimes the link is a bit hidden):
https://cpython-previews--102328.org.readthedocs.build/en/102328/library/http.client.html#httpconnection-objects
Sorry, something went wrong.
|
Note for the dev who will merge: please edit the commit message to avoid reusing the whole original post here with its questions and screenshot |
Sorry, something went wrong.
|
What are the next steps to move this review forward?
(1) Would it be helpful if I squashed/rebased this commit to the tip of the main branch? (2) Do I need to summon someone with merge permissions? If so, is there a list of such folks publicly listed? |
Sorry, something went wrong.
|
I will re-review later today from computer. Thanks. |
Sorry, something went wrong.
|
The approval was reset by me actually, not a title change! Note that all PRs for CPython are squash merged, so rebases are not needed. (In fact the devguide recommends against them, as force pushes do weird things for reviewers: ghost notifications, comments losing context) |
Sorry, something went wrong.
Mariatta
left a comment
There was a problem hiding this comment.
Thank you!
Sorry, something went wrong.
|
Thanks @davidfstr for the PR, and @Mariatta for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11. |
Sorry, something went wrong.

Added example on how to use the HTTPConnection object for making GET request.
Original issue: #102327