Skip to content

Commit

Permalink
Doc: Add make autoformat to the contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Petr Viktorin committed Mar 14, 2018
1 parent db24276 commit 0473e87
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions Doc/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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_.
Expand Down

0 comments on commit 0473e87

Please sign in to comment.