diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2017-02-12 18:00:28 -0500 |
|---|---|---|
| committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2017-02-12 18:00:28 -0500 |
| commit | c8549139d3061a12d8583b844d8c7d7a235d980a (patch) | |
| tree | 92ba049a9354be95f8e2e60391ebae146b8eb515 /docs/settingchanges.rst | |
| parent | 9450c289961081c0b8fdb3fc702787727c856a5b (diff) | |
| download | cmd2-git-c8549139d3061a12d8583b844d8c7d7a235d980a.tar.gz | |
Documentation updates
Sphinx documenation updates, including:
- Extensively re-wrote the "alternatives to cmd2" section as it was many years out of date
- Reworded a few humorous sections in an attempt to be more professional
- Removed reference to command synonyms/aliases which no longer exist
- Added more detail in a couple places
- Minor rewording and bugfixes throughout
Also added a note to cmd2.py about the expected values for doctest only working for Python 2.7.
Diffstat (limited to 'docs/settingchanges.rst')
| -rw-r--r-- | docs/settingchanges.rst | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/settingchanges.rst b/docs/settingchanges.rst index d2bf2cc7..94849246 100644 --- a/docs/settingchanges.rst +++ b/docs/settingchanges.rst @@ -16,8 +16,8 @@ By default, all ``cmd2`` command names are case-insensitive; set ``App.case_insensitive`` to False. Whether or not you set ``case_insensitive``, *please do not* define -command method names with any uppercase letters. ``cmd2`` will probably -do something evil if you do. +command method names with any uppercase letters. ``cmd2`` expects all command methods +to be lowercase. Shortcuts ========= @@ -118,3 +118,7 @@ with:: quiet: False # Don't print nonessential feedback timing: False # Report execution times +Any of these user-settable parameters can be set while running your app with the ``set`` command like so:: + + set abbrev False + |