summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFlorent Xicluna <florent.xicluna@gmail.com>2013-02-24 11:52:16 +0100
committerFlorent Xicluna <florent.xicluna@gmail.com>2013-02-24 11:52:16 +0100
commit0214593a9c1356fb073266fdf0f714061a7b28df (patch)
tree935affce14f8ff506c570681ac321c019bce6c99 /docs
parenta53c56912dc9a9af0b339190d8da35abffbc181b (diff)
downloadpep8-0214593a9c1356fb073266fdf0f714061a7b28df.tar.gz
Advertize the pep8-naming extension
Diffstat (limited to 'docs')
-rw-r--r--docs/intro.rst12
1 files changed, 4 insertions, 8 deletions
diff --git a/docs/intro.rst b/docs/intro.rst
index 1456956..e7d0ab3 100644
--- a/docs/intro.rst
+++ b/docs/intro.rst
@@ -42,14 +42,10 @@ Always remember this statement from `PEP 8`_:
Among other things, these features are currently not in the scope of
the ``pep8`` library:
-* **naming conventions**: there's `a feature request
- <https://github.com/jcrocholl/pep8/issues/44>`_ with `a patch
- <https://github.com/jcrocholl/pep8/pull/121>`_, but it might
- be too disruptive to include it in the library: currently it's easy to make
- an existing project clean regarding ``pep8`` checks; it can be done without
- changing the API or the behaviour of the existing code. It's not the same
- for naming conventions: if you change the name of a class or a method, it
- will break more code which depends on the library.
+* **naming conventions**: this kind of feature is supported through plugins.
+ Install `flake8 <https://pypi.python.org/pypi/flake8>`_ and the
+ `pep8-naming extension <https://pypi.python.org/pypi/pep8-naming>`_ to use
+ this feature.
* **docstring conventions**: they are not in the scope of this library;
see the `pep257 project <https://github.com/GreenSteam/pep257>`_.
* **automatic fixing**: see the section *PEP8 Fixers* in the