From a63b4159c0c2cd4706c4ead276d8eb3e053865d8 Mon Sep 17 00:00:00 2001 From: Darrell Schiebel Date: Thu, 11 Apr 2024 18:38:44 -0400 Subject: [PATCH] fix wording --- README.rst | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 9de165c..368c3cd 100644 --- a/README.rst +++ b/README.rst @@ -1,24 +1,23 @@ Remote Jupyter Kernels via SSH tunnels ###################################### -The design of this pakage is based upon `SSH Kernel `_ which is -in turn based upon `remote_ikernel `_. This implementation shares -the same command line parameters as `SSH Kernel `_, but it was -reimplemented from scratch to support Python 3.10. It also includes an :code:`ls` implementation which allows -checking on the available kernel specifications. +The design of this pakage is based upon `SSH Kernel `_ which +in turn is based upon `remote_ikernel `_. This implementation shares +a common set of command line parameters with `SSH Kernel `_, but it was +implemented from scratch to support Python 3.10. This package adds an :code:`ls` implementation which allows +listing info about the available kernel specifications. While there are modest additions to `SSH Kernel `_, there are -also modest subtractions. There are fewer configuration options for things like the name that -`Jupyter Client `_ uses to refer to the -kernel. This is still based on the kernel description that the user sees, but the entire name -is no longer completely configurable. +also modest subtractions. There are fewer configuration options for things like the internal name used +by `Jupyter Client `_ to refer to the created +kernel. Listing the Jupyter Kernels that are available ********************************************** -It can be difficult to know which Jupyter Kernels are available because there is more than one location that +It can be difficult to know which Jupyter Kernels are available because there are multiple locations where the `Kernel Spec files `_ can be -stored. :code:`sshpyk` has an :code:`ls` option to all for seeing which kernels are available (even if they are +found. :code:`sshpyk` has an :code:`ls` option which lists the kernels that are available (even those which are **not** `SSH Kernel `_ or :code:`sshpyk` kernels:: bash$ @@ -36,11 +35,12 @@ should **not** be checked. The :code:`-a` (or :code:`--all`) flag indicates that specifications rather than just the ones for `SSH Kernel `_ or :code:`sshpyk` kernel specification files. -If :code:`--no-check` is **not** supplied, then as part of listing the kernel information :code:`sshpyk` will +If :code:`--no-check` is **not** supplied, part of listing the kernel information will include verify that the Python executable specified in the kernel specification exist on the local and remote systems. -:code:`--local` will limit the check to just the local Python executable and :code:`--remote` will limit the -check to only the remote Python executable. These options also list the local or remote Python path **instead** -of the path to the kernel specification directory. +This check allows the ouput to be colorized so red text indicates a problem. :code:`--local` will limit the +check to just the local Python executable and :code:`--remote` will limit the check to only the remote Python +executable. These options also list the local or remote Python path **instead** of the path to the kernel +specification directory. Command line "ls" options