diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2017-07-03 20:01:33 -0400 |
|---|---|---|
| committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2017-07-03 20:01:33 -0400 |
| commit | 2c3bd0a5177be980e17b4befc79cbda3825cf63b (patch) | |
| tree | 69b94aa20da0f6b11538748c8d4c9e6b6585a89e /docs | |
| parent | 7c17d8bbf006e17f0104b6d9d35fc67ca4f235fd (diff) | |
| download | cmd2-git-2c3bd0a5177be980e17b4befc79cbda3825cf63b.tar.gz | |
Updated Sphinx docs
Updated to reflect that the default value of abbrev is now False.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/freefeatures.rst | 6 | ||||
| -rw-r--r-- | docs/settingchanges.rst | 4 |
2 files changed, 5 insertions, 5 deletions
diff --git a/docs/freefeatures.rst b/docs/freefeatures.rst index 2d928ad3..7381ff8e 100644 --- a/docs/freefeatures.rst +++ b/docs/freefeatures.rst @@ -265,13 +265,13 @@ Abbreviated commands ==================== ``cmd2`` apps will accept shortened command names -so long as there is no ambiguity. Thus, if -``do_divide`` is defined, then ``divid``, ``div``, +so long as there is no ambiguity if the ``abrev`` settable parameter is set to ``True``. +Thus, if ``do_divide`` is defined, then ``divid``, ``div``, or even ``d`` will suffice, so long as there are no other commands defined beginning with *divid*, *div*, or *d*. -This behavior can be turned off with ``app.abbrev`` (see :ref:`parameters`) +This behavior is disabled by default, but can be turned on with ``app.abbrev`` (see :ref:`parameters`) .. warning:: diff --git a/docs/settingchanges.rst b/docs/settingchanges.rst index d09543d6..326db3f5 100644 --- a/docs/settingchanges.rst +++ b/docs/settingchanges.rst @@ -103,7 +103,7 @@ comments, is viewable from within a running application with:: (Cmd) set --long - abbrev: True # Accept abbreviated commands + abbrev: False # Accept abbreviated commands autorun_on_edit: False # Automatically run files after editing colors: True # Colorized output (*nix only) continuation_prompt: > # On 2nd+ line of input @@ -118,5 +118,5 @@ with:: Any of these user-settable parameters can be set while running your app with the ``set`` command like so:: - set abbrev False + set abbrev True |