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/index.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/index.rst')
| -rw-r--r-- | docs/index.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst index 8045cd49..ce295be7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,7 +33,7 @@ The basic use of ``cmd2`` is identical to that of cmd_. .. note:: - The tab-completion capability provided by cmd_ relies on underlying capability provided by GNU readline or an + The tab-completion feature provided by cmd_ relies on underlying capability provided by GNU readline or an equivalent library. Linux distros will almost always come with the required library installed. For Mac OS X, we recommend installing the `gnureadline <https://pypi.python.org/pypi/gnureadline>`_ Python module. For Windows, we recommend installing the `pyreadline <https://pypi.python.org/pypi/pyreadline>`_ Python module. |