summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2018-07-17 22:32:31 -0400
committerTodd Leonhardt <todd.leonhardt@gmail.com>2018-07-17 22:32:31 -0400
commit24a21c475af3cdadd21b2e744a6ee534c504ae69 (patch)
treecd0f469184d1fe05affc5137ff56e7ae87e6bff4
parentca26abe0231158cfa22355a4f77d38f8aa7bd1ec (diff)
downloadcmd2-git-24a21c475af3cdadd21b2e744a6ee534c504ae69.tar.gz
Fix documentation in regards to requirements on Python 3.4
Added typing backport dependency for Python 3.4
-rwxr-xr-xREADME.md3
-rw-r--r--docs/install.rst6
2 files changed, 5 insertions, 4 deletions
diff --git a/README.md b/README.md
index b1828794..a60f0a18 100755
--- a/README.md
+++ b/README.md
@@ -62,7 +62,8 @@ the only 3rd-party dependencies being on [attrs](https://github.com/python-attrs
[colorama](https://github.com/tartley/colorama), and [pyperclip](https://github.com/asweigart/pyperclip).
Windows has an additional dependency on [pyreadline](https://pypi.python.org/pypi/pyreadline). Non-Windows platforms
have an additional dependency on [wcwidth](https://pypi.python.org/pypi/wcwidth). Finally, Python
-3.4 has an additional dependency on [contextlib2](https://pypi.python.org/pypi/contextlib2).
+3.4 has additional dependencies on [contextlib2](https://pypi.python.org/pypi/contextlib2) and the
+[typing](https://pypi.org/project/typing/) backport.
For information on other installation options, see
[Installation Instructions](https://cmd2.readthedocs.io/en/latest/install.html) in the cmd2
diff --git a/docs/install.rst b/docs/install.rst
index 120fd3b9..3578ce25 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -126,10 +126,10 @@ If you wish to permanently uninstall ``cmd2``, this can also easily be done with
pip uninstall cmd2
-Extra requirement for Python 3.4
---------------------------------
+Extra requirements for Python 3.4
+---------------------------------
``cmd2`` requires the ``contextlib2`` module for Python 3.4. This is used to temporarily redirect
-stdout and stderr.
+stdout and stderr. Also when using Python 3.4, ``cmd2`` requires the ``typing`` module backport.
Extra requirement for macOS
===========================