Add documentation to jupyter-kernel-manager slots

This commit is contained in:
Nathaniel Nicandro 2018-01-18 22:43:52 -06:00
parent 6c44684a9a
commit f27fad472b

View file

@ -38,26 +38,31 @@
(defgroup jupyter-kernel-manager nil (defgroup jupyter-kernel-manager nil
"Jupyter kernel manager" "Jupyter kernel manager"
:group 'communication) :group 'jupyter)
(defclass jupyter-kernel-manager (jupyter-connection) (defclass jupyter-kernel-manager (jupyter-connection)
((name ((name
:initarg :name :initarg :name
:type string) :type string
:documentation "The name of the kernel that is being managed.")
(conn-file (conn-file
:type (or null string)) :type (or null string)
:documentation "The absolute path of the connection file when
the kernel is alive.")
(kernel (kernel
:type (or null process) :type (or null process)
:initform nil :initform nil
:documentation "The local kernel process or nil if no local :documentation "The local kernel process when the kernel is
kernel was started by this client.") alive.")
(control-channel (control-channel
:type (or null jupyter-control-channel) :type (or null jupyter-control-channel)
:initform nil)
:initform nil :initform nil
:documentation "A control channel to make shutdown and
interrupt requests to the kernel.")
(spec (spec
:type (or null json-plist) :type (or null json-plist)
:initform nil))) :initform nil
:documentation "The kernelspec used to start/restart the kernel.")))
(cl-defmethod initialize-instance ((manager jupyter-kernel-manager) &rest _slots) (cl-defmethod initialize-instance ((manager jupyter-kernel-manager) &rest _slots)
"Initialize MANAGER based on SLOTS. "Initialize MANAGER based on SLOTS.