summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIan Lee <IanLee1521@gmail.com>2016-10-29 14:38:08 -0700
committerGitHub <noreply@github.com>2016-10-29 14:38:08 -0700
commit05ec89f52eebb470e0dea4fded34237b2dc82f89 (patch)
treef0260f009970e78fd2bcae79504d740e8563e7fe
parentd4a60037be95b4b5f84a040bc40ce2ca703640bb (diff)
downloadpep8-05ec89f52eebb470e0dea4fded34237b2dc82f89.tar.gz
Updated the doc index with not about new name
Taken from latest pycodestyle README
-rw-r--r--docs/index.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 5e4a4c5..2d33ba2 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,6 +3,16 @@
pep8's documentation
====================
+.. note::
+
+ This package used to be called ``pep8`` but was renamed to ``pycodestyle``
+ to reduce confusion. Further discussion can be found `in the issue where
+ Guido requested this
+ change <https://github.com/PyCQA/pycodestyle/issues/466>`_, or in the
+ lightning talk at PyCon 2016 by @IanLee1521:
+ `slides <https://speakerdeck.com/ianlee1521/pep8-vs-pep-8>`_
+ `video <https://youtu.be/PulzIT8KYLk?t=36m>`_.
+
*Python style guide checker*
pep8 is a tool to check your Python code against some of the style