Skip to content

Commit 5d37a3a

Browse files
committed
Update kernelspec env bullet in docs
1 parent fe30ee1 commit 5d37a3a

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/kernels.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,10 @@ JSON serialised dictionary containing the following keys and values:
152152
the client will default to ``signal`` mode.
153153
- **env** (optional): A dictionary of environment variables to set for the kernel.
154154
These will be added to the current environment variables before the kernel is
155-
started.
155+
started. Existing environment variables can be referenced using ``${<ENV_VAR>}`` and
156+
will be substituted with the corresponding value. Administrators should note that use
157+
of ``${<ENV_VAR>}`` can expose sensitive variables and should use only in controlled
158+
circumstances.
156159
- **metadata** (optional): A dictionary of additional attributes about this
157160
kernel; used by clients to aid in kernel selection. Metadata added
158161
here should be namespaced for the tool reading and writing that metadata.

0 commit comments

Comments
 (0)