From bf3dc169c047acda1c1cf505e8cd0e9e46d4b4cf Mon Sep 17 00:00:00 2001 From: kotfu Date: Wed, 5 Feb 2020 22:31:18 -0700 Subject: 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 --- docs/features/embedded_python_shells.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/features/embedded_python_shells.rst') 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 -- cgit v1.2.1