Add formatting instructions authored by galberding's avatar galberding
......@@ -65,3 +65,14 @@ def myfunc(name: str) -> None:
"""
```
All special commands are listed [here](https://www.doxygen.nl/manual/commands.html#cmddef).
## Formatting
In order to keep a consistent style the code formatter [yapf](https://github.com/google/yapf) is used.
Install it with:
```bash
pip install yapf
```
In order to quickly format all files in the repository issue
```bash
yapf --style='{based_on_style: facebook, indent_width: 4, split_before_logical_operator: True}' -r -p -i .
```