You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Include references to the used algorithms in the docstring
4
+
* If the algorithm is new, please include a description in the docstring, or be sure to include a reference as soon as you publish the work
5
+
* The code should be easily readable (for infos e.g. here [here](https://treyhunner.com/2017/07/craft-your-python-like-poetry/?__s=jf8h91lx6zhl7vv6o9jo))
6
+
* Variable names should be chosen to be clear. Avoid `item, element, var, list` etc...
7
+
* 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
+
* Use pythonic loops, list comprehensions etc.
9
+
* Make sure the unit test are testing all the relevant parts of the code
10
+
* Check the docstring (is everything clearly explained, are the default values given an clear)
0 commit comments