summaryrefslogtreecommitdiff
path: root/docs/features/embedded_python_shells.rst
diff options
context:
space:
mode:
authorkotfu <kotfu@kotfu.net>2020-02-05 22:31:18 -0700
committerkotfu <kotfu@kotfu.net>2020-02-05 22:31:18 -0700
commitbf3dc169c047acda1c1cf505e8cd0e9e46d4b4cf (patch)
treee4542578e14c2274dbc7e60271faa163d535007e /docs/features/embedded_python_shells.rst
parent60a212c1c585f0c4c06ffcfeb9882520af8dbf35 (diff)
downloadcmd2-git-bf3dc169c047acda1c1cf505e8cd0e9e46d4b4cf.tar.gz
Clean up class and method references
- In docs/api/cmd.rst, the `cmd2.Cmd` class was defined as `cmd2.cmd2.Cmd`, which required the extraneous `cmd2` every time we referenced it. This extra `cmd2` is no longer required. - always refer to a bare cmd2 using ``cmd2`` per our documentation conventions
Diffstat (limited to 'docs/features/embedded_python_shells.rst')
-rw-r--r--docs/features/embedded_python_shells.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/features/embedded_python_shells.rst b/docs/features/embedded_python_shells.rst
index 0af2f737..68377876 100644
--- a/docs/features/embedded_python_shells.rst
+++ b/docs/features/embedded_python_shells.rst
@@ -5,12 +5,12 @@ The ``py`` command will run its arguments as a Python command. Entered without
arguments, it enters an interactive Python session. The session can call
"back" to your application through the name defined in ``self.pyscript_name``
(defaults to ``app``). This wrapper provides access to execute commands in
-your cmd2 application while maintaining isolation.
+your ``cmd2`` application while maintaining isolation.
You may optionally enable full access to to your application by setting
``self_in_py`` to ``True``. Enabling this flag adds ``self`` to the python
-session, which is a reference to your Cmd2 application. This can be useful for
-debugging your application.
+session, which is a reference to your ``cmd2`` application. This can be useful
+for debugging your application.
The ``app`` object (or your custom name) provides access to application
commands through raw commands. For example, any application command call be