summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2020-01-27 21:48:02 -0500
committerTodd Leonhardt <todd.leonhardt@gmail.com>2020-01-27 21:48:02 -0500
commit9dcc2078d41ffeef1e1ac675d5809b535d76a81d (patch)
tree1a2f2b11913c43cbd11a333411ff76ea34116529
parent64c1d702235f6e9c7aae64793bd39ce48a1c3b4a (diff)
downloadcmd2-git-9dcc2078d41ffeef1e1ac675d5809b535d76a81d.tar.gz
Deleted info on the instance attributes which might only be used in extremely rare circumstances
-rw-r--r--docs/features/initialization.rst21
1 files changed, 2 insertions, 19 deletions
diff --git a/docs/features/initialization.rst b/docs/features/initialization.rst
index 7ad26b7d..39e36428 100644
--- a/docs/features/initialization.rst
+++ b/docs/features/initialization.rst
@@ -87,8 +87,8 @@ The ``cmd2.Cmd`` class provides a large number of public instance attributes
which allow developers to customize a ``cmd2`` application further beyond the
options provided by the ``__init__()`` method.
-Common instance attributes to override
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Public instance attributes
+~~~~~~~~~~~~~~~~~~~~~~~~~~
Here are instance attributes of ``cmd2.Cmd`` which developers might wish
override:
@@ -148,20 +148,3 @@ override:
are settable at runtime using the *set* command
- **timing**: if ``True`` display execution time for each command (Default:
``False``)
-
-Rare instance attributes to override
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-These instance attributes are used by built-in tab-completion functions.
-
-These instance attributes really are not intended for ``cmd2`` developers to
-override, but they are there for unusual circumstances where it may be
-necessary:
-
-- **sigint_protection**: context manager used to protect critical sections in
- the main thread from stopping due to a KeyboardInterrupt
-- **statement_parser**: object which parses all command line arguments (it
- would be extremely rare to use something other than the default for this)
-- **terminal_lock**: this lock should be acquired before doing any asynchronous
- changes to the terminal to ensure the updates to the terminal don't interfere
- with the input being typed or output being printed by a command.