Skip to content

Commit

Permalink
docs: include info about ruff in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yoctoyotta1024 committed May 7, 2024
1 parent 28a2502 commit 81fcb31
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/source/usage/good_coding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,9 @@ by automated tools such as `Cocogitto-bot <https://github.com/apps/cocogitto-bot

Code Style / Formatting
-----------------------
For Python, we obey the PEP 8 style guide.
For Python, we obey the default settings of `ruff <https://docs.astral.sh/ruff/>`_` for formatting
and linting. Ruff checks are something like the combination of several Python linters
(Flake8, isort, pydocstyle etc.) and the black formatter.

For C++ we obey the Google C++ Style Guide with:
| IndentWidth: 2
Expand Down

0 comments on commit 81fcb31

Please sign in to comment.