From 5a1f4de23cee2a7daa536b902526e9346b95619a Mon Sep 17 00:00:00 2001 From: Dave Cranwell Date: Fri, 15 May 2015 09:33:45 +0100 Subject: [PATCH] replaced bullets with headings in python guidelines --- docs/contributing/developing.rst | 2 ++ docs/contributing/python_guidelines.rst | 21 ++++++++++++++++++--- 2 files changed, 20 insertions(+), 3 deletions(-) diff --git a/docs/contributing/developing.rst b/docs/contributing/developing.rst index 290ae4731c..77b715f687 100644 --- a/docs/contributing/developing.rst +++ b/docs/contributing/developing.rst @@ -38,6 +38,8 @@ The list of dependencies is in the Wagtail root directory in ``requirements-dev. pip install -r requirements-dev.txt +.. _testing: + Testing ~~~~~~~ diff --git a/docs/contributing/python_guidelines.rst b/docs/contributing/python_guidelines.rst index a20cd4de70..0956c264b3 100644 --- a/docs/contributing/python_guidelines.rst +++ b/docs/contributing/python_guidelines.rst @@ -1,6 +1,21 @@ Python coding guidelines ======================== -* PEP8. We ask that all Python contributions adhere to the `PEP8 `_ style guide, apart from the restriction on line length (E501). The `pep8 tool `_ makes it easy to check your code, e.g. ``pep8 --ignore=E501 your_file.py``. -* Python 2 and 3 compatibility. All contributions should support Python 2 and 3 and we recommend using the `six `_ compatibility library (use the pip version installed as a dependency, not the version bundled with Django). -* Tests. Wagtail has a suite of tests, which we are committed to improving and expanding. We run continuous integration at `travis-ci.org/torchbox/wagtail `_ to ensure that no commits or pull requests introduce test failures. If your contributions add functionality to Wagtail, please include the additional tests to cover it; if your contributions alter existing functionality, please update the relevant tests accordingly. +PEP8 +~~~~ + +We ask that all Python contributions adhere to the `PEP8 `_ style guide, apart from the restriction on line length (E501). The `pep8 tool `_ makes it easy to check your code, e.g. ``pep8 --ignore=E501 your_file.py``. + + +Python 2 and 3 compatibility +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +All contributions should support Python 2 and 3 and we recommend using the `six `_ compatibility library (use the pip version installed as a dependency, not the version bundled with Django). + + +Tests +~~~~~ + +Wagtail has a suite of tests, which we are committed to improving and expanding. See :ref:`testing`. + +We run continuous integration at `travis-ci.org/torchbox/wagtail `_ to ensure that no commits or pull requests introduce test failures. If your contributions add functionality to Wagtail, please include the additional tests to cover it; if your contributions alter existing functionality, please update the relevant tests accordingly.