From a07fdb7c16d1df4838b3ca15301e37ae5923e68a Mon Sep 17 00:00:00 2001 From: Matthias Date: Mon, 16 May 2022 01:18:55 +0200 Subject: [PATCH] add docstring comment --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c36c11b62b..12e6b6674b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -90,7 +90,8 @@ The various github actions can be found in the `./github/workflows` directory ## Code Style -Sumbitted Python code is automatically checked against PEP style guidelines. Locally you can run `invoke style` to ensure the style checks will pass, before submitting the PR. +Sumbitted Python code is automatically checked against PEP style guidelines. Locally you can run `invoke style` to ensure the style checks will pass, before submitting the PR. +Please write docstrings for each function and class - we follow the [google doc-style](https://google.github.io/styleguide/pyguide.html#244-decision) for python. Docstrings for general javascript code is encouraged! Docstyles are checked by `invoke style`. ## Documentation