Skip to content

Commit e4e4a40

Browse files
Revise console usage documentation
Updated the console documentation to enhance clarity and detail. - move link to IPython full list of magic commands to the bottom of page
1 parent 22d90b6 commit e4e4a40

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

docs/03_getting_started/console.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Celbridge comes with a **Console** panel offering a CLI (Command Line Interface
1616

1717
.. sidebar:: The IPython REPL
1818

19-
The console panel is rendered using `Xterm.js <https://xtermjs.org/>`_ hosted in a WebView2. The Xterm.js terminal is connected to a terminal emulator session via `ConPTY <https://devblogs.microsoft.com/commandline/windows-command-line-introducing-the-windows-pseudo-console-conpty/>`_ which is hosting a Python process. The REPL environment is implemented using `IPython <https://ipython.org/>`_ (the same tech used in `Jupyter Notebooks <https://jupyter.org/>`_). The IPython REPL is a full replacement for the built-in Python REPL that adds a lot of useful functionality. We support all the standard IPython magic commands, such as %run, !, %ls, etc. Here's a `full list <https://ipython.readthedocs.io/en/stable/interactive/magics.html>`_.
19+
The console panel is rendered using `Xterm.js <https://xtermjs.org/>`_ hosted in a WebView2. The Xterm.js terminal is connected to a terminal emulator session via `ConPTY <https://devblogs.microsoft.com/commandline/windows-command-line-introducing-the-windows-pseudo-console-conpty/>`_ which is hosting a Python process. The REPL environment is implemented using `IPython <https://ipython.org/>`_ (the same tech used in `Jupyter Notebooks <https://jupyter.org/>`_). The IPython REPL is a full replacement for the built-in Python REPL that adds a lot of useful functionality. We support all the standard IPython magic commands, such as %run, !, %ls, etc.
2020

2121

2222

@@ -51,7 +51,7 @@ This terminal offers a full Python `REPL <https://en.wikipedia.org/wiki/Read%E2%
5151
CLI commands
5252
------------
5353

54-
It also offers a range of commands for running CLI programs, available using the band "`!`" character. Examples including:
54+
It also offers a range of commands for running CLI programs, available using the bang "`!`" character. Examples including:
5555

5656
1. Directory list (in this example I'm working from an **X:** drive in a Celbridge project named **celbridge_sample**):
5757

@@ -87,4 +87,7 @@ Learn more about REPLs and this console at:
8787
- `CLI (Command Line Interface (terminal)) <https://en.wikipedia.org/wiki/Command-line_interface>`_
8888
- `MAKE <https://en.wikipedia.org/wiki/Make_(software)>`_
8989

90+
The IPython documentation pages provide
91+
a `full list of the magic commands <https://ipython.readthedocs.io/en/stable/interactive/magics.html>`_
92+
9093

0 commit comments

Comments
 (0)