diff options
Diffstat (limited to 'docs/features')
| -rw-r--r-- | docs/features/embedded_python_shells.rst | 2 | ||||
| -rw-r--r-- | docs/features/initialization.rst | 6 |
2 files changed, 4 insertions, 4 deletions
diff --git a/docs/features/embedded_python_shells.rst b/docs/features/embedded_python_shells.rst index 3386e8cd..0af2f737 100644 --- a/docs/features/embedded_python_shells.rst +++ b/docs/features/embedded_python_shells.rst @@ -8,7 +8,7 @@ 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. diff --git a/docs/features/initialization.rst b/docs/features/initialization.rst index 864741cd..c5df5af8 100644 --- a/docs/features/initialization.rst +++ b/docs/features/initialization.rst @@ -39,7 +39,7 @@ capabilities which you may wish to utilize while initializing the app:: self.continuation_prompt = '... ' # Allow access to your application in py and ipy via self - self.locals_in_py = True + self.self_in_py = True # Set the default category name self.default_category = 'cmd2 Built-in Commands' @@ -125,7 +125,7 @@ override: of results in a Python script or interactive console. Built-in commands don't make use of this. It is purely there for user-defined commands and convenience. -- **locals_in_py**: if ``True`` allow access to your application in *py* +- **self_in_py**: if ``True`` allow access to your application in *py* command via ``self`` (Default: ``False``) - **macros**: dictionary of macro names and their values - **max_completion_items**: max number of CompletionItems to display during @@ -139,7 +139,7 @@ override: ``app``) - **py_locals**: dictionary that defines specific variables/functions available in Python shells and scripts (provides more fine-grained control than making - everything available with **locals_in_py**) + everything available with **self_in_py**) - **quiet**: if ``True`` then completely suppress nonessential output (Default: ``False``) - **quit_on_sigint**: if ``True`` quit the main loop on interrupt instead of |