summaryrefslogtreecommitdiff
path: root/docs/features/initialization.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/initialization.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/initialization.rst')
-rw-r--r--docs/features/initialization.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/features/initialization.rst b/docs/features/initialization.rst
index 39e36428..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'
@@ -110,7 +110,7 @@ override:
DisabledCommand objects.
- **echo**: if ``True``, each command the user issues will be repeated to the
screen before it is executed. This is particularly useful when running
- scripts. This behavior does not occur when a running command at the prompt.
+ scripts. This behavior does not occur when running a command at the prompt.
(Default: ``False``)
- **editor**: text editor program to use with *edit* command (e.g. ``vim``)
- **exclude_from_history**: commands to exclude from the *history* command
@@ -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