Skip to content

Commit d998226

Browse files
committed
Fix lists in contributor guidlines
1 parent 80cc0ec commit d998226

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

docs/development.rst

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Before opening a pull request, make sure that:
66
1. The code builds.
77
2. The docs build.
88
3. The linters pass.
9-
4. All tests pass.
9+
4. The tests pass.
1010
5. Test coverage has not decreased.
1111

1212
Building & Installing
@@ -65,8 +65,9 @@ General
6565
- Maximum line length is 88 characters, but aim for less than 80.
6666
- Maximum `cyclomatic complexity`_ is ten, but aim for five or lower.
6767
- 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.
7071

7172
.. _`cyclomatic complexity`: https://en.wikipedia.org/wiki/Cyclomatic_complexity
7273

@@ -78,8 +79,10 @@ Imports
7879
- Within import groups, :code:`import`-style imports come before :code:`from`-style imports.
7980
- One :code:`import`-style import per line.
8081
- 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+
8386
- Imports are sorted alphabetically within groups.
8487

8588
Comments and docstrings
@@ -88,6 +91,8 @@ Comments and docstrings
8891
- Blank line after module- and class-level docstrings, but not after method-level docstrings.
8992
- Comments start with a capital letter and end with a period if they are contain at least two words.
9093
- 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+
9297
- Avoid multiline comments.
9398

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