Skip to content

Commit 0473e87

Browse files
committed
Doc: Add make autoformat to the contributing guide
1 parent db24276 commit 0473e87

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

Doc/contributing.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,17 @@ Specify a different one using, for example::
102102

103103
Notable targets are:
104104

105+
``make autoformat``
106+
Automatically re-formats C and Python code to conform to Python style
107+
guides (`PEP 7`_ and `PEP 8`_).
108+
Note that no backups are made – please commit any other changes before
109+
using this target.
110+
111+
Requires the ``indent`` program and the ``autopep8`` Python module.
112+
113+
.. _PEP 7: https://www.python.org/dev/peps/pep-0007/
114+
.. _PEP 8: https://www.python.org/dev/peps/pep-0008/
115+
105116
``make lcov lcov-open``
106117
Generate and view test coverage for C code.
107118
Requires LCOV_.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy