Documentation for Kernel Subshells #17623
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for making a pull request to jupyterlab! |
|
Thanks @MUFFANUJ! cc @ianthomas23 if you would like to have a look too |
krassowski
reviewed
Jun 28, 2025
krassowski
reviewed
Jun 28, 2025
Comment on lines
+1111
to
+1117
| **Communication Settings** | ||
|
|
||
| Configure how widget `comms <https://jupyter-client.readthedocs.io/en/stable/messaging.html#custom-messages>`__ use subshells via Settings → Advanced Settings → Kernel: | ||
|
|
||
| - ``disabled``: No subshells for comms | ||
| - ``perCommTarget``: One subshell per comm target (default) | ||
| - ``perComm``: One subshell per comm (can create many subshells) |
There was a problem hiding this comment.
Should it be in user documentation instead?
krassowski
reviewed
Jun 28, 2025
Comment on lines
+1056
to
+1070
| **User Interface** | ||
|
|
||
| Users can create subshell consoles in two ways: | ||
|
|
||
| 1. **Command Palette**: Press ``Ctrl+Shift+C`` and search for "New Subshell Console for Notebook" | ||
| 2. **Context Menu**: Right-click in a notebook (only visible when kernel supports subshells) | ||
|
|
||
| To verify subshell functionality, use the ``%subshell`` magic command in Python kernels: | ||
|
|
||
| .. code:: python | ||
|
|
||
| %subshell | ||
| # Output shows: | ||
| # subshell id: None (main shell) or unique ID (subshell) | ||
| # subshell list: ['id1', 'id2', ...] (active subshells) |
There was a problem hiding this comment.
This is duplicated with a very similar section in user-facing docs, can you replace it with one sentence linking to _subshell-console target?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
References
fixes #17446
Code changes
Added the Documentation for the Kernel Subshells.