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/freefeatures.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/freefeatures.rst')
| -rw-r--r-- | docs/freefeatures.rst | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/docs/freefeatures.rst b/docs/freefeatures.rst index 9e739cc6..03378a07 100644 --- a/docs/freefeatures.rst +++ b/docs/freefeatures.rst @@ -32,9 +32,8 @@ are recognized; you may change this by overriding ``app.commentGrammars`` with a different pyparsing_ grammar. -Comments can be useful in :ref:`scripts`. Used -in an interactive session, they may indicate -mental imbalance. +Comments can be useful in :ref:`scripts`, but would +be pointless within an interactive session. :: @@ -105,9 +104,10 @@ command. Entered without arguments, it enters an interactive Python session. That session can call "back" to your application with ``cmd("")``. Through ``self``, it also has access to your application -instance itself. (If that thought terrifies you, -you can set the ``locals_in_py`` parameter to ``False``. -See see :ref:`parameters`) +instance itself which can be extremely useful for debugging. +(If giving end-users this level of introspection is inappropriate, +the ``locals_in_py`` parameter can be set to ``False`` and removed +from the settable dictionary. See see :ref:`parameters`) :: @@ -157,8 +157,7 @@ also provide `bash-like history list editing`_. Quitting the application ======================== -``cmd2`` pre-defines a ``quit`` command for you (with -synonyms ``exit`` and simply ``q``). +``cmd2`` pre-defines a ``quit`` command for you. It's trivial, but it's one less thing for you to remember. |
