Skip to content

Commit daa0fca

Browse files
authored
Merge pull request #820 from dandersson/pep8-is-now-pycodestyle
`pep8` is nowadays called `pycodestyle`
2 parents 88b5223 + 3f8f2fd commit daa0fca

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

docs/dev/env.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ source files.
3535
There is also a handy syntax plugin called syntax_ featuring some improvements
3636
over the syntax file included in Vim 6.1.
3737

38-
These plugins supply you with a basic environment for developing in Python.
39-
To get the most out of Vim, you should continually check your code for syntax
40-
errors and PEP8 compliance. Luckily PEP8_ and Pyflakes_ will do this for you.
41-
If your Vim is compiled with ``+python`` you can also utilize some very
42-
handy plugins to do these checks from within the editor.
38+
These plugins supply you with a basic environment for developing in Python. To
39+
get the most out of Vim, you should continually check your code for syntax
40+
errors and PEP8 compliance. Luckily pycodestyle_ and Pyflakes_ will do this
41+
for you. If your Vim is compiled with ``+python`` you can also utilize some
42+
very handy plugins to do these checks from within the editor.
4343

4444
For PEP8 checking and pyflakes, you can install vim-flake8_. Now you can map the
4545
function ``Flake8`` to any hotkey or action you want in Vim. The plugin will
@@ -68,12 +68,12 @@ Python-mode
6868
Python-mode_ is a complex solution for working with Python code in Vim.
6969
It has:
7070

71-
- Asynchronous Python code checking (``pylint``, ``pyflakes``, ``pep8``, ``mccabe``) in any combination
71+
- Asynchronous Python code checking (``pylint``, ``pyflakes``, ``pycodestyle``, ``mccabe``) in any combination
7272
- Code refactoring and autocompletion with Rope
7373
- Fast Python folding
7474
- Virtualenv support
7575
- Search through Python documentation and run Python code
76-
- Auto PEP8_ error fixes
76+
- Auto pycodestyle_ error fixes
7777

7878
And more.
7979

@@ -86,7 +86,7 @@ using ``<Tab>`` key or any other customized keys.
8686
.. _indent: http://www.vim.org/scripts/script.php?script_id=974
8787
.. _syntax: http://www.vim.org/scripts/script.php?script_id=790
8888
.. _Pyflakes: http://pypi.python.org/pypi/pyflakes/
89-
.. _PEP8: http://pypi.python.org/pypi/pep8/
89+
.. _pycodestyle: https://pypi.python.org/pypi/pycodestyle/
9090
.. _syntastic: https://github.com/scrooloose/syntastic
9191
.. _Python-mode: https://github.com/klen/python-mode
9292
.. _SuperTab: http://www.vim.org/scripts/script.php?script_id=1643

docs/writing/style.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -459,23 +459,23 @@ best to adhere to the guidelines laid out within this document. Some project
459459
may sway from it from time to time, while others may
460460
`amend its recommendations <http://docs.python-requests.org/en/master/dev/contributing/#kenneth-reitz-s-code-style>`_.
461461

462-
That being said, conforming your Python code to PEP 8 is generally a good
463-
idea and helps make code more consistent when working on projects with other
464-
developers. There is a command-line program, `pep8 <https://github.com/jcrocholl/pep8>`_,
465-
that can check your code for conformance. Install it by running the following
466-
command in your terminal:
462+
That being said, conforming your Python code to PEP 8 is generally a good idea
463+
and helps make code more consistent when working on projects with other
464+
developers. There is a command-line program, `pycodestyle <https://github.com/PyCQA/pycodestyle>`_
465+
(previously known as ``pep8``), that can check your code for conformance.
466+
Install it by running the following command in your terminal:
467467

468468

469469
.. code-block:: console
470470
471-
$ pip install pep8
471+
$ pip install pycodestyle
472472
473473
474474
Then run it on a file or series of files to get a report of any violations.
475475

476476
.. code-block:: console
477477
478-
$ pep8 optparse.py
478+
$ pycodestyle optparse.py
479479
optparse.py:69:11: E401 multiple imports on one line
480480
optparse.py:77:1: E302 expected 2 blank lines, found 1
481481
optparse.py:88:5: E301 expected 1 blank line, found 0

0 commit comments

Comments
 (0)