blob: 539da50f44ee8da54b3c9c2ebb7e69d3f95c77d8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
This repository has a mandatory code review policy. Contributions
should happen through pull requests. Never commit to ``master``
directly.
When in doubt, refer to PEP 8 for Python code.
Write docstrings like this::
def some_function(some_arg):
"""
Does some things.
:param some_arg: Some argument.
"""
So, specifically:
- Always use three double quotes.
- Put the three double quotes on their own line.
- No blank line at the end.
- Use Sphinx parameter/attribute documentation syntax.
|
