Document auto-login disabling (#1127)

globus · Jan 14, 2025 · 1a33571 · 1a33571
1 parent 12497e4
commit 1a33571
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/changelog.d/20250114_150601_derek_fix_app_config_doc_ivar.rst b/changelog.d/20250114_150601_derek_fix_app_config_doc_ivar.rst
@@ -0,0 +1,6 @@
+
+Documentation
+~~~~~~~~~~~~~
+
+- Updated GlobusAppConfig docs to explain how to disable auto-login. (:pr:`NUMBER`)
+
diff --git a/src/globus_sdk/globus_app/config.py b/src/globus_sdk/globus_app/config.py
@@ -95,8 +95,9 @@ class GlobusAppConfig:
             Explicit values must be pre-registered on your client
             `here <https://app.globus.org/settings/developers>`_.
 
-    :ivar ``TokenValidationErrorHandler`` token_validation_error_handler: A handler
-        invoked to resolve errors raised during token validation.
+    :ivar ``TokenValidationErrorHandler`` | None token_validation_error_handler: A
+        handler invoked to resolve errors raised during token validation. Set this to
+        ``None`` to disable auto-login on service token validation errors.
         Default: ``resolve_by_login_flow`` (runs a login flow, storing the resulting
         tokens).