Skip to content

Commit 0facfec

Browse files
committed
Improve docstring/fix typo
1 parent 5f6bc16 commit 0facfec

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

Diff for: jupyter_server/auth/decorator.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ def allow_unauthenticated(method: FuncT) -> FuncT:
9595
is active when `ServerApp.allow_unauthenticated_access = False`.
9696
9797
To be used exclusively on endpoints which may be considered public,
98-
for example the logic page handler.
98+
for example the login page handler.
9999
100100
.. versionadded:: 2.13
101101

Diff for: jupyter_server/utils.py

+5-1
Original file line numberDiff line numberDiff line change
@@ -442,4 +442,8 @@ def import_item(name: str) -> Any:
442442

443443

444444
class JupyterServerAuthWarning(RuntimeWarning):
445-
"""A subclass of runtime warnings to allow for filtering in tests"""
445+
"""Emitted when authentication configuration issue is detected.
446+
447+
Intended for filtering out expected warnings in tests, including
448+
downstream tests, rather than for users to silence this warning.
449+
"""

0 commit comments

Comments
 (0)