Skip to content

Commit baf8daf

Browse files
author
schmide
committed
Merge branch 'develop' into main
2 parents 6216786 + 5a6f7fa commit baf8daf

File tree

2 files changed

+3
-12
lines changed

2 files changed

+3
-12
lines changed

doc/guide/Reviewer_Checklist.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
* The code should be easily readable (for infos e.g. here [here](https://treyhunner.com/2017/07/craft-your-python-like-poetry/?__s=jf8h91lx6zhl7vv6o9jo))
66
* Variable names should be chosen to be clear. Avoid `item, element, var, list` etc...
77
* Avoid as much as possible hard-coded indices for list (no `x = l[0], y = l[1]`) (see also [here](https://treyhunner.com/2018/03/tuple-unpacking-improves-python-code-readability/))
8+
* Avoid mutable as default values for functions and methods.
89
* Use pythonic loops, list comprehensions etc.
910
* Make sure the unit test are testing all the relevant parts of the code
1011
* Check the docstring (is everything clearly explained, are the default values given an clear)

doc/guide/coding_conventions.rst

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Coding Conventions
44
==================
55

6-
Contributions are very welcome! But we need to keep a certain order. Please seriously consider the following guidelines.
6+
Contributions are very welcome! But we need to keep a certain order. Please earnestly consider the following guidelines.
77

88
Unit Tests
99
----------
@@ -77,16 +77,6 @@ Cython, Numba, ...
7777
- When using Numba, make sure to avoid Python objects as, otherwise, Numba will
7878
use the less efficient `object mode <https://numba.pydata.org/numba-doc/latest/glossary.html#term-object-mode>`_.
7979

80-
Exposed Interface
81-
=================
82-
Library functions???
83-
8480
Configuration
8581
=============
86-
Dealing with constants
87-
----------------------
88-
??? central registry?
89-
90-
Dealing with defaults
91-
---------------------
92-
???
82+
- URLs of external resources and locations of data directories should always be defined in the config.py file and not declared as constants.

0 commit comments

Comments
 (0)