-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Document the parameters for urllib3.request()
#3177
Conversation
This is copied from HTTP(S)ConnectionPool.urlopen.
This is copied from HTTP(S)ConnectionPool.urlopen.
This is copied from HTTP(S)ConnectionPool.urlopen.
This is copied from HTTP(S)ConnectionPool.urlopen. Note that for the top-level urllib3 method, the omission of the pool headers is deliberate -- this is a high-level convenience method, and the user may not be aware of the default pool at this point.
These descriptions are copied from HTTP(S)ConnectionPool.urlopen.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
I was concerned about exposing internal types on the provided screenshots, but the types look good like previously on https://urllib3--3177.org.readthedocs.build/en/3177/reference/urllib3.request.html
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM too, thanks @alexwlchan!
@alexwlchan This issue is eligible for a $100 bounty on our Open Collective! You can submit an expense there linking to this pull request and we'll review it :) Thanks again! |
This documents the
urllib3.request()
function, and a couple of its intermediaries, as described in #3011.I built the docs locally to check the parameters were appearing correctly in both the user and reference guide. I did get one warning, but I think it was unrelated to my change. (
urllib3/src/urllib3/contrib/socks.py:docstring of urllib3.contrib.socks.SOCKSConnection.socket_options:1:py:class reference target not found: connection._TYPE_SOCKET_OPTIONS
)https://urllib3.readthedocs.io/en/stable/reference/urllib3.request.html:
https://urllib3.readthedocs.io/en/stable/reference/urllib3.poolmanager.html#urllib3.PoolManager.request (linked from
request()
in the user guide):Notes for reviewers
HTTP(S)ConnectionPool.urlopen()
, with the exception ofjson
andfields
.Fixes #3011