Changes
Page history
Update Coding standards
authored
Jun 15, 2023
by
fima
Show whitespace changes
Inline
Side-by-side
Home/Coding-standards.md
View page @
d664bac4
...
@@ -29,3 +29,16 @@ So I guess it's okay if we have a few guidelines. The [Google Python Style Guide
...
@@ -29,3 +29,16 @@ So I guess it's okay if we have a few guidelines. The [Google Python Style Guide
-
Use comments to explain complex code.
-
Use comments to explain complex code.
-
Use docstrings to document modules, classes, and functions.
-
Use docstrings to document modules, classes, and functions.
-
Follow the "Google Style" for docstrings (reStructuredText format).
-
Follow the "Google Style" for docstrings (reStructuredText format).
# Testing
As much as possible, we should write automatic tests for our code using
`pytest`
Tests should be located in a
`tests`
directory, at the root of your repository.
In this directory, create a file for each module of your package, name following the convention
`test_modulename.py`
.
For example, your project structure could be like this:
Let's say you have a project
\ No newline at end of file