ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-13 07:47:14 +03:00
Code Issues Projects Releases Wiki Activity

Contributing: missing/incorrect docstrings will fail flake8

Browse Source
This commit is contained in:
Athanasius 2021-06-07 12:33:12 +01:00
parent f7272ee445
commit da790826e9
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Contributing.md
View File

@ -393,6 +393,9 @@ literals.
Doc strings are preferred on all new modules, functions, classes, and methods, as they help others understand your code.
We use the `sphinx` formatting style, which for pycharm users is the default.
Lack of docstrings, or them not passing some checks, *will* cause a flake8
failure in our setup.
---
## Comments