summaryrefslogtreecommitdiff
path: root/docs/features/embedded_python_shells.rst
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2020-01-28 15:12:49 -0500
committerGitHub <noreply@github.com>2020-01-28 15:12:49 -0500
commit5a88fcf4a54c834edf70bf75020763a23d49f146 (patch)
treefd271ddc070c2f7df9563d3a81d6d9bd8a188688 /docs/features/embedded_python_shells.rst
parent95f8d883496044bcb95ce803752a8851de6ad0e5 (diff)
parent691d7759dab0c8a0e11b5c64bfb84c25fcfc7515 (diff)
downloadcmd2-git-5a88fcf4a54c834edf70bf75020763a23d49f146.tar.gz
Merge pull request #864 from python-cmd2/reduce_settable_attributes
Reduce settable attributes and renamed locals_in_py
Diffstat (limited to 'docs/features/embedded_python_shells.rst')
-rw-r--r--docs/features/embedded_python_shells.rst6
1 files changed, 2 insertions, 4 deletions
diff --git a/docs/features/embedded_python_shells.rst b/docs/features/embedded_python_shells.rst
index 9d721c2c..0af2f737 100644
--- a/docs/features/embedded_python_shells.rst
+++ b/docs/features/embedded_python_shells.rst
@@ -8,11 +8,9 @@ arguments, it enters an interactive Python session. The session can call
your cmd2 application while maintaining isolation.
You may optionally enable full access to to your application by setting
-``locals_in_py`` to ``True``. Enabling this flag adds ``self`` to the python
+``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. To prevent users from enabling this ability
-manually you'll need to remove ``locals_in_py`` from the ``settable``
-dictionary.
+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