Skip to content

Commit 578bea4

Browse files
committed
clarify separator details
1 parent e0dcac4 commit 578bea4

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs/kernels.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,7 @@ The user location takes priority over the system locations, and the case of the
109109
names is ignored, so selecting kernels works the same way whether or not the
110110
filesystem is case sensitive.
111111
Since kernelspecs show up in URLs and other places,
112-
they are required to be simple names, only containing ASCII letters and numbers,
113-
and the simple separators: ``-``, ``.``, ``_``.
112+
a kernelspec is required to have a simple name, only containing ASCII letters, ASCII numbers, and the simple separators: ``-`` hyphen, ``.`` period, ``_`` underscore.
114113

115114
Other locations may also be searched if the :envvar:`JUPYTER_PATH` environment
116115
variable is set.

jupyter_client/kernelspec.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ def _is_valid_kernel_name(name):
6565
return _kernel_name_pat.match(name)
6666

6767

68-
_kernel_name_description = "Kernel names can only contain ASCII letters and numbers and these separators: -._"
68+
_kernel_name_description = "Kernel names can only contain ASCII letters and numbers and these separators:" \
69+
" - . _ (hyphen, period, and underscore)."
6970

7071

7172
def _is_kernel_dir(path):

0 commit comments

Comments
 (0)