From 430b814f043e20d3ad298812c41ac513af945fa8 Mon Sep 17 00:00:00 2001
From: Simon Li <orpheus+devel@gmail.com>
Date: Thu, 18 May 2023 14:34:23 +0100
Subject: [PATCH] doc: `http_request_kwargs`: link to Tornado `HTTPRequest` doc

---
 oauthenticator/oauth2.py | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/oauthenticator/oauth2.py b/oauthenticator/oauth2.py
index 4ea66811..3d892b6a 100644
--- 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,
     )