| Hynek Schlawack | 2ae675d | 2013-08-07 21:01:07 +0200 | [diff] [blame] | 1 | Process |
| 2 | ======= |
| 3 | |
| Laurens Van Houtven | 380a369 | 2013-08-07 11:03:40 +0200 | [diff] [blame] | 4 | This repository has a mandatory code review policy. Contributions |
| 5 | should happen through pull requests. Never commit to ``master`` |
| 6 | directly. |
| 7 | |
| Hynek Schlawack | 2ae675d | 2013-08-07 21:01:07 +0200 | [diff] [blame] | 8 | Code |
| 9 | ==== |
| Laurens Van Houtven | 380a369 | 2013-08-07 11:03:40 +0200 | [diff] [blame] | 10 | |
| Hynek Schlawack | 2ae675d | 2013-08-07 21:01:07 +0200 | [diff] [blame] | 11 | When in doubt, refer to `PEP 8`_ for Python code. |
| 12 | |
| 13 | Docs |
| 14 | ==== |
| 15 | |
| 16 | Write docstrings like this: |
| 17 | |
| 18 | .. code-block:: python |
| Laurens Van Houtven | 380a369 | 2013-08-07 11:03:40 +0200 | [diff] [blame] | 19 | |
| 20 | def some_function(some_arg): |
| 21 | """ |
| 22 | Does some things. |
| 23 | |
| 24 | :param some_arg: Some argument. |
| 25 | """ |
| 26 | |
| 27 | So, specifically: |
| 28 | |
| 29 | - Always use three double quotes. |
| 30 | - Put the three double quotes on their own line. |
| 31 | - No blank line at the end. |
| Hynek Schlawack | 2ae675d | 2013-08-07 21:01:07 +0200 | [diff] [blame] | 32 | - Use Sphinx parameter/attribute documentation `syntax`_. |
| 33 | |
| 34 | |
| 35 | .. _`PEP 8`: http://www.peps.io/8/ |
| 36 | .. _`syntax`: http://sphinx-doc.org/domains.html#info-field-lists |