summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2019-03-13 23:33:58 -0400
committerTodd Leonhardt <todd.leonhardt@gmail.com>2019-03-13 23:33:58 -0400
commit88b45e12b0c2c9e7f8e386504f2d6808f396560b (patch)
tree66209a092dc11528f73a9cb1a991c620be09a815 /docs
parent23fad46d5187600d52b95125bb1629e491cb9e6f (diff)
downloadcmd2-git-88b45e12b0c2c9e7f8e386504f2d6808f396560b.tar.gz
First stage of attribute refactoring
The following are now arguments to cmd2.Cmd.__init__() instead of class attributes: * allow_redirection * multiline_commands * terminators * shortcuts Added a couple read-only properties for convenience of cmd2.Cmd accessing immutable members from self.statement_parser
Diffstat (limited to 'docs')
-rw-r--r--docs/settingchanges.rst2
-rw-r--r--docs/unfreefeatures.rst5
2 files changed, 3 insertions, 4 deletions
diff --git a/docs/settingchanges.rst b/docs/settingchanges.rst
index e1c437e4..c9345bc6 100644
--- a/docs/settingchanges.rst
+++ b/docs/settingchanges.rst
@@ -44,7 +44,7 @@ To define more shortcuts, update the dict ``App.shortcuts`` with the
Shortcuts need to be created by updating the ``shortcuts`` dictionary attribute prior to calling the
``cmd2.Cmd`` super class ``__init__()`` method. Moreover, that super class init method needs to be called after
updating the ``shortcuts`` attribute This warning applies in general to many other attributes which are not
- settable at runtime such as ``multiline_commands``, etc.
+ settable at runtime.
Aliases
diff --git a/docs/unfreefeatures.rst b/docs/unfreefeatures.rst
index 97953215..071a15b2 100644
--- a/docs/unfreefeatures.rst
+++ b/docs/unfreefeatures.rst
@@ -7,12 +7,11 @@ Multiline commands
Command input may span multiple lines for the
commands whose names are listed in the
-parameter ``app.multiline_commands``. These
+``multiline_commands`` argument to ``cmd2.Cmd.__init__()``. These
commands will be executed only
after the user has entered a *terminator*.
By default, the command terminator is
-``;``; replacing or appending to the list
-``app.terminators`` allows different
+``;``; specifying the ``terminators`` optional argument to ``cmd2.Cmd.__init__()`` allows different
terminators. A blank line
is *always* considered a command terminator
(cannot be overridden).