thebe icon indicating copy to clipboard operation
thebe copied to clipboard

Should kernelOptions.name be removed from docs?

Open choldgraf opened this issue 6 years ago • 1 comments

In the readme instructions we mention kernelOptions.name but I can't tell whether it's used at all, I believe the kernelOptions dict is used by JupyterLab and it doesn't seem like .name is used anywhere, perhaps we should remove it?

choldgraf avatar Dec 26 '19 08:12 choldgraf

kernalOptions.name is passed in as the name of a session connection. The comments of @jupyterlab/services(the package thebelab uses) shows:

 #### Notes
 The `path` and `type` session model parameters are required. The `name`
 parameter is not technically required, but is often assumed to be nonempty,
 so we require it too.

As it suggests keeping the name parameter, I think keeping it would be a good idea. However, using python3 as a value might be confusing. I suggest changing it to something related to a session name to be clear.

narrator0 avatar Dec 29 '19 06:12 narrator0