@@ -6,7 +6,7 @@ Before opening a pull request, make sure that:
6
6
1. The code builds.
7
7
2. The docs build.
8
8
3. The linters pass.
9
- 4. All tests pass.
9
+ 4. The tests pass.
10
10
5. Test coverage has not decreased.
11
11
12
12
Building & Installing
@@ -65,8 +65,9 @@ General
65
65
- Maximum line length is 88 characters, but aim for less than 80.
66
66
- Maximum `cyclomatic complexity `_ is ten, but aim for five or lower.
67
67
- Blank lines before and after statements (for, if, return, ...), unless
68
- - the statement comes at the beginning or end of another statement.
69
- - the indentation level is five lines or fewer long.
68
+
69
+ - the statement comes at the beginning or end of another statement.
70
+ - the indentation level is five lines or fewer long.
70
71
71
72
.. _`cyclomatic complexity` : https://en.wikipedia.org/wiki/Cyclomatic_complexity
72
73
@@ -78,8 +79,10 @@ Imports
78
79
- Within import groups, :code: `import `-style imports come before :code: `from `-style imports.
79
80
- One :code: `import `-style import per line.
80
81
- All :code: `from `-style imports from a specific package or module on the same line, unless that would violate the line length limit.
81
- - In that case, strongly consider using :code: `import `-style instead.
82
- - If that is not possible, use one import per line.
82
+
83
+ - In that case, strongly consider using :code: `import `-style instead.
84
+ - If that is not possible, use one import per line.
85
+
83
86
- Imports are sorted alphabetically within groups.
84
87
85
88
Comments and docstrings
@@ -88,6 +91,8 @@ Comments and docstrings
88
91
- Blank line after module- and class-level docstrings, but not after method-level docstrings.
89
92
- Comments start with a capital letter and end with a period if they are contain at least two words.
90
93
- Comments go on the same line as the code they explain, unless that would violate the line length limit.
91
- - In that case, the comment goes immediately before the code it explains.
94
+
95
+ - In that case, the comment goes immediately before the code it explains.
96
+
92
97
- Avoid multiline comments.
93
98
0 commit comments