Skip to content

Commit 3f1aeea

Browse files
docs: update urllib3 docstrings for v2 compatibility (#1903)
Updates docstrings in `google/auth/transport/urllib3.py` to reference `urllib3.PoolManager` instead of the removed/private `urllib3.request.RequestMethods`, ensuring compatibility with `urllib3` v2 documentation standards. NOTE: This PR supercedes an [older PR #1290](#1290), because some of the content or suggested changes in the older PR are overtaken by events and/or been incorporated via [other recent PRs](#1389). --- *PR created automatically by Jules for task [17649723998293325458](https://jules.google.com/task/17649723998293325458) started by @chalmerlowe* Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com> Co-authored-by: Chalmer Lowe <[email protected]>
1 parent f9e9187 commit 3f1aeea

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

google/auth/transport/urllib3.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,8 @@ class Request(transport.Request):
106106
credentials.refresh(request)
107107
108108
Args:
109-
http (urllib3.request.RequestMethods): An instance of any urllib3
110-
class that implements :class:`~urllib3.request.RequestMethods`,
111-
usually :class:`urllib3.PoolManager`.
109+
http (urllib3.PoolManager): An instance of a urllib3 class that implements
110+
the request interface (e.g. :class:`urllib3.PoolManager`).
112111
113112
.. automethod:: __call__
114113
"""
@@ -209,7 +208,7 @@ class AuthorizedHttp(RequestMethods): # type: ignore
209208
response = authed_http.request(
210209
'GET', 'https://www.googleapis.com/storage/v1/b')
211210
212-
This class implements :class:`urllib3.request.RequestMethods` and can be
211+
This class implements the urllib3 request interface and can be
213212
used just like any other :class:`urllib3.PoolManager`.
214213
215214
The underlying :meth:`urlopen` implementation handles adding the

0 commit comments

Comments
 (0)