Improve docstring/fix typo

jupyter-server · Feb 13, 2024 · 0facfec · 0facfec
1 parent 5f6bc16
commit 0facfec
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/jupyter_server/auth/decorator.py b/jupyter_server/auth/decorator.py
@@ -95,7 +95,7 @@ def allow_unauthenticated(method: FuncT) -> FuncT:
     is active when `ServerApp.allow_unauthenticated_access = False`.
 
     To be used exclusively on endpoints which may be considered public,
-    for example the logic page handler.
+    for example the login page handler.
 
     .. versionadded:: 2.13
 

diff --git a/jupyter_server/utils.py b/jupyter_server/utils.py
@@ -442,4 +442,8 @@ def import_item(name: str) -> Any:
 
 
 class JupyterServerAuthWarning(RuntimeWarning):
-    """A subclass of runtime warnings to allow for filtering in tests"""
+    """Emitted when authentication configuration issue is detected.
+
+    Intended for filtering out expected warnings in tests, including
+    downstream tests, rather than for users to silence this warning.
+    """