From 0473e8764215a6586aef36d470f4eaa7f81e3fdc Mon Sep 17 00:00:00 2001 From: Petr Viktorin Date: Wed, 14 Mar 2018 12:54:24 +0100 Subject: [PATCH] Doc: Add `make autoformat` to the contributing guide --- Doc/contributing.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/Doc/contributing.rst b/Doc/contributing.rst index 9061332..badb931 100644 --- a/Doc/contributing.rst +++ b/Doc/contributing.rst @@ -102,6 +102,17 @@ Specify a different one using, for example:: Notable targets are: +``make autoformat`` + Automatically re-formats C and Python code to conform to Python style + guides (`PEP 7`_ and `PEP 8`_). + Note that no backups are made – please commit any other changes before + using this target. + + Requires the ``indent`` program and the ``autopep8`` Python module. + +.. _PEP 7: https://www.python.org/dev/peps/pep-0007/ +.. _PEP 8: https://www.python.org/dev/peps/pep-0008/ + ``make lcov lcov-open`` Generate and view test coverage for C code. Requires LCOV_.