File tree 1 file changed +10
-9
lines changed 1 file changed +10
-9
lines changed Original file line number Diff line number Diff line change 1
1
2
2
Conventions to follow while hacking:
3
3
4
- 1. API should return data, not text.
4
+
5
+ 1. API should return data, not text
5
6
6
7
2. functions or methods which print to stdout should be named with a
7
- prefix of cli_ and should only be used when invoked via the
8
- CLI. ie. API calls should not print to stdout.
8
+ prefix of cli_ and should only be used when invoked via the CLI. Pure
9
+ API calls should not print to stdout.
9
10
10
11
3. Two blank lines after every function and method
11
12
12
13
4. Separate blocks of ideas within a function with a single blank line
13
14
14
- 5. flake8 otherwise
15
+ 5. flake8 (as configured in setup.cfg) otherwise
15
16
16
17
6. imports at the module level unless doing something tricky. Use
17
18
relative imports as appropriate
18
19
19
20
7. don't over-nest function calls. don't be afraid to use a local
20
21
variable to hold data between steps. It can be much clearer to read
21
- later.
22
+ later
23
+
24
+ 8. delete-trailing-whitespace or whatever it's called in your editor
22
25
23
- 8. delete-trailing-whitespace
26
+ 9. Run `tox` and fix any unexpected issues before committing.
24
27
25
- 9. Run `./setup.py flake8` and `./setup.py test` and fix any
26
- unexpected issues before committing.
28
+ 10. Add yourself to AUTHORS and your change to ChangeLog
27
29
28
30
29
- #
30
31
# The end.
You can’t perform that action at this time.
0 commit comments