1
0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-13 15:57:14 +03:00

Contributing: --- separators between each ##

This commit is contained in:
Athanasius 2021-06-07 12:21:00 +01:00
parent 3c13e84910
commit 81652a54c2

View File

@ -223,6 +223,8 @@ Otherwise, see the [pytest documentation](https://docs.pytest.org/en/stable/cont
Yes, this means using 'color' rather than 'colour', and in general will mean US, not British, spellings.
---
## Control flow
Never oneline any control flow (`if`, `else`, `for`), as it makes spotting what happens next difficult.
@ -268,11 +270,15 @@ No:
return
```
---
## Use Type hints
Please do place [type hints](https://docs.python.org/3/library/typing.html) on the declarations of your functions,
both their arguments and return types.
---
## Use `logging` not `print()`, and definitely not `sys.stdout.write()`
`EDMarketConnector.py` sets up a `logging.Logger` for this under the
@ -352,6 +358,8 @@ In addition to that we utilise one of the user-defined levels as:
command-line argument and `.bat` file for users to enable it. It cannot be
selected from Settings in the UI.
---
## Prefer fstrings to modulo-formatting and .format
[fstrings](https://www.python.org/dev/peps/pep-0498/) are new in python 3.6, and allow for string interpolation rather
@ -360,11 +368,15 @@ than more opaque formatting calls.
As part of our flake8 linting setup we have included a linter that warns when you use either `%` or `.format` on string
literals.
---
## Docstrings
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.
---
## Comments
### Add comments to LANG usage