Skip to content

Commit 9dcc207

Browse files
committed
Deleted info on the instance attributes which might only be used in extremely rare circumstances
1 parent 64c1d70 commit 9dcc207

File tree

1 file changed

+2
-19
lines changed

1 file changed

+2
-19
lines changed

docs/features/initialization.rst

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@ The ``cmd2.Cmd`` class provides a large number of public instance attributes
8787
which allow developers to customize a ``cmd2`` application further beyond the
8888
options provided by the ``__init__()`` method.
8989

90-
Common instance attributes to override
91-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90+
Public instance attributes
91+
~~~~~~~~~~~~~~~~~~~~~~~~~~
9292
Here are instance attributes of ``cmd2.Cmd`` which developers might wish
9393
override:
9494

@@ -148,20 +148,3 @@ override:
148148
are settable at runtime using the *set* command
149149
- **timing**: if ``True`` display execution time for each command (Default:
150150
``False``)
151-
152-
Rare instance attributes to override
153-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
154-
155-
These instance attributes are used by built-in tab-completion functions.
156-
157-
These instance attributes really are not intended for ``cmd2`` developers to
158-
override, but they are there for unusual circumstances where it may be
159-
necessary:
160-
161-
- **sigint_protection**: context manager used to protect critical sections in
162-
the main thread from stopping due to a KeyboardInterrupt
163-
- **statement_parser**: object which parses all command line arguments (it
164-
would be extremely rare to use something other than the default for this)
165-
- **terminal_lock**: this lock should be acquired before doing any asynchronous
166-
changes to the terminal to ensure the updates to the terminal don't interfere
167-
with the input being typed or output being printed by a command.

0 commit comments

Comments
 (0)