4264be2b18
* orphans testing pages to avoid not-in-toctree errors * orphans various pages pending reorg * adds module_utils and special_vars to main TOC * uses a glob for scenario_guide TOC * normalize and Sentence-case headings on community pages, typos * re-orgs community TOC, adds all pages to toctree * removes scenario guides index page * adds style guide to community index * basic update to style guide * fix typo that created a new error * removes not-in-toctree from ignore errors list * leave removing files for future cleanup task
1.9 KiB
- orphan
PEP 8
Topics
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 PEP 8 tests are executed, except those listed in the current ignore list.
Changes to the Rule Set need approval from the Core Team, and must be done via the Testing Working Group.
Legacy Rule Set
Files which are listed in the legacy file list are tested using the legacy rule set.
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.
This is intended to prevent regressions on style guidelines for files which pass the more stringent current rule set.
Skipping Tests
Files listed in the skip list are not tested by pycodestyle.
Removed Files
Files which have been removed from the repository must be removed from the legacy file list and the skip list.
Running Locally
The PEP 8 check can be run locally with:
./test/runner/ansible-test sanity --test pep8 [file-or-directory-path-to-check] ...