Merge pull request #614 from manics/http_request_kwargs-doc

`http_request_kwargs`: link to Tornado `HTTPRequest` doc
jupyterhub · May 18, 2023 · 79252e7 · 79252e7
2 parents 921824c + 430b814
commit 79252e7
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/oauthenticator/oauth2.py b/oauthenticator/oauth2.py
@@ -396,7 +396,11 @@ def _validate_server_cert_default(self):
         For example, to use a HTTP proxy for all requests:
 
         `c.OAuthenticator.http_request_kwargs = {"proxy_host": "proxy.example.com", "proxy_port": 8080}`
-        }
+
+        See the `tornado.httpclient.HTTPRequest` documentation for all options and limitations:
+        https://www.tornadoweb.org/en/stable/httpclient.html#tornado.httpclient.HTTPRequest
+
+        Note that some of these are dependent on the httpclient implementation.
         """,
         config=True,
     )