Browse Source

doc edits about code consoles.

Jason Grout 7 years ago
parent
commit
fb60ab7f7f
2 changed files with 25 additions and 12 deletions
  1. 18 12
      docs/source/user/code_console.md
  2. 7 0
      docs/source/user/notebook.md

+ 18 - 12
docs/source/user/code_console.md

@@ -1,27 +1,33 @@
 
 # Code Consoles
 
-Notebooks allow you to write and run code while you create a document. At times,
-it is helpful to write and run code in an exploratory manner, while not creating
-a document; a sort of transient playground for interactive code. The JupyterLab
-Code Console addresses this usage case, with full support for the rich output of
-Jupyter.
+Code consoles allow you to run code interactively in a kernel. The cells of a
+code console show the order in which code was executed in the kernel, as opposed
+to the explicit ordering of cells in a notebook document. Code consoles also
+display rich output, just like notebook cells.
 
-Create a code console by clicking the + button in the File Browser and selecting
-the kernel:
+Create a new code console by clicking the `+` button in the file browser and
+selecting the kernel:
 
 [animation]
 
-Run code using `Shift Enter` and use the up and down arrows allow you to browse
-the history of previously run code:
+Run code using `Shift Enter`. Use the up and down arrows to browse
+the history of previously-run code:
 
 [animation]
 
-Tab completion (`Tab`) and tooltips (`Shift Tab`) work as in the Notebook:
+Tab completion (`Tab`) and tooltips (`Shift Tab`) work as in the notebook:
 
 [animation]
 
-You can clear the previous cells of the Code Console by right-clicking on the
-Code Console and selecting the “Clear Console Cells” item:
+Clear the cells of the code console without restarting the kernel by
+right-clicking on the code console and selecting “Clear Console Cells”:
+
+[animation]
+
+Creating a code console from the File menu lets you select an existing kernel
+for the code console. The code console then acts as a log of computations in
+that kernel, and a place you can interactively inspect and run code in the
+kernel:
 
 [animation]

+ 7 - 0
docs/source/user/notebook.md

@@ -64,3 +64,10 @@ The tooltip (activated with `Shift Tab`) contains additional information about
 objects:
 
 [animation]
+
+You can connect a code console to a notebook kernel to have a log of computations done
+in the kernel, in the order in which they were done. The attached code console
+also provides a place to interactively inspect kernel state without changing the
+notebook. Right-click on a notebook and select “Create Console for Notebook”:
+
+[animation]