ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-27 23:21:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Use pycodestyle instead of pep8 (#25947)

Browse source
This commit is contained in:
Pilou 2017-07-13 20:46:31 +02:00 • committed by Matt Clay
commit 4b3d6dfa8a
8 changed files with 19 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/docsite/rst/dev_guide/testing_pep8.rst
View file

@ -4,13 +4,13 @@ PEP 8
.. contents:: Topics
`PEP 8`_ style guidelines are enforced by ``pep8`` on all python files in the repository by default.
`PEP 8`_ style guidelines are enforced by `pycodestyle`_ on all python files in the repository by default.
Current Rule Set
================
By default all files are tested using the current rule set.
All ``pep8`` tests are executed, except those listed in the `current ignore list`_.
All `PEP 8`_ tests are executed, except those listed in the `current ignore list`_.
.. warning: Updating the Rule Set
@ -21,7 +21,7 @@ Legacy Rule Set
Files which are listed in the `legacy file list`_ are tested using the legacy rule set.
All ``pep8`` tests are executed, except those listed in the `current ignore list`_ or `legacy ignore list`_.
All `PEP 8`_ tests are executed, except those listed in the `current ignore list`_ or `legacy ignore list`_.
Files listed in the legacy file list which pass the current rule set will result in an error.
@ -30,7 +30,7 @@ This is intended to prevent regressions on style guidelines for files which pass
Skipping Tests
==============
Files listed in the `skip list`_ are not tested by ``pep8``.
Files listed in the `skip list`_ are not tested by `pycodestyle`_.
Removed Files
=============
@ -40,7 +40,7 @@ Files which have been removed from the repository must be removed from the legac
Running Locally
===============
The pep8 check can be run locally with::
The `PEP 8`_ check can be run locally with::
./test/runner/ansible-test sanity --test pep8 [file-or-directory-path-to-check] ...
@ -48,7 +48,7 @@ The pep8 check can be run locally with::
.. _PEP 8: https://www.python.org/dev/peps/pep-0008/
.. _pep8: https://pypi.python.org/pypi/pep8
.. _pycodestyle: https://pypi.python.org/pypi/pycodestyle
.. _current ignore list: https://github.com/ansible/ansible/blob/devel/test/sanity/pep8/current-ignore.txt
.. _legacy file list: https://github.com/ansible/ansible/blob/devel/test/sanity/pep8/legacy-files.txt
.. _legacy ignore list: https://github.com/ansible/ansible/blob/devel/test/sanity/pep8/legacy-ignore.txt