Mirrored_Repos/InvenTree
1
0
Fork 0
mirror of https://github.com/inventree/InvenTree synced 2024-08-30 18:33:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

add docstring comment

Browse Source
This commit is contained in:
Matthias 2022-05-16 01:18:55 +02:00
parent c5db595b54
commit a07fdb7c16
No known key found for this signature in database
GPG Key ID: AB6D0E6C4CB65093
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.md
View File

@ -90,7 +90,8 @@ The various github actions can be found in the `./github/workflows` directory
## Code Style ## 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 ## Documentation