diff options
Diffstat (limited to 'CODING_GUIDELINES.md')
| -rw-r--r-- | CODING_GUIDELINES.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/CODING_GUIDELINES.md b/CODING_GUIDELINES.md index f11af31d78..60bf41ea65 100644 --- a/CODING_GUIDELINES.md +++ b/CODING_GUIDELINES.md @@ -14,15 +14,15 @@ Language * While not all components of Ansible must be in Python, core contributions to the Ansible repo must be written in Python. This is to maximize the ability of everyone to contribute. * If you want to write non-Python ansible modules or inventory scripts, that's fine, but they are not going to get merged in most likely. Sorry!! -PEP 8 and basic style checks +PEP8 and basic style checks =========================== - * [PEP 8](https://www.python.org/dev/peps/pep-0008/) is a great Python style guide, which you should read. - * PEP 8 must not be strictly followed in all aspects, but most of it is good advice + * PEP8 is a great Python style guide, which you should read. + * PEP8 must not be strictly followed in all aspects, but most of it is good advice * In particular, we don't really care about line lengths. Buy a bigger monitor! - * To run checks for things we care about, use [ansible-test](http://docs.ansible.com/ansible/dev_guide/testing_pep8.html#running-locally). + * To run checks for things we care about, run "make pep8" * Similarly, additional checks can be made with "make pyflakes" - * There is no need to submit code changes for PEP 8 and pyflakes fixes, as these break attribution history. Project leadership will make these periodically. + * There is no need to submit code changes for pep8 and pyflake fixes, as these break attribution history. Project leadership will make these periodically. * Do not submit pull requests that simply adjust whitespace in the code Testing |