Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
blink1073 committed Oct 31, 2022
1 parent 8faf083 commit f78dd2d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
7 changes: 4 additions & 3 deletions jupyter_client/manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -303,9 +303,10 @@ async def _async_launch_kernel(self, kernel_cmd: t.List[str], **kw: t.Any) -> No
"""actually launch the kernel
override in a subclass to launch kernel subprocesses differently
Note that provisioners can now be used to customize kernel environments. The provisioner is in charge of setting up the connection
info and file using its `parent` object either in its `launch_kernel`
or `pre_launch` kernel methods.
Note that provisioners can now be used to customize kernel environments.
The provisioner is responsible for setting up our connection info
and file either in ``launch_kernel`` or ``pre_launch_kernel``.
See `KernelProvisionerBase.launch_kernel` for more information.
"""
assert self.provisioner is not None
await self.provisioner.launch_kernel(kernel_cmd, **kw)
Expand Down
5 changes: 0 additions & 5 deletions jupyter_client/provisioning/provisioner_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,11 +178,6 @@ async def post_launch(self, **kwargs: Any) -> None:
This method is called from `KernelManager.post_start_kernel()` as part of its
start kernel sequence.
Note: Provisioners are expected to use the KernelManager (the `parent`
attribute) to handle connection info as needed either in this method or
in `pre_launch` so that the connection file is ready when the kernel
process needs access to it.
"""
pass

Expand Down

0 comments on commit f78dd2d

Please sign in to comment.