Skip to content

style: format code with Black, isort and Prettier #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/example_docs/other/linting.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ When you installed the `[dev]` dependencies, you installed several code-formatti
2. [`isort`](https://pycqa.github.io/isort/): A utility that will sort your import statements for you, which you can use by running `isort .` in the base directory.
3. [`ruff`](https://docs.astral.sh/ruff/): A versatile Python linter to clean up your code, which you can use by running `ruff . --fix` in the base directory.
4. [`docformatter`](https://github.com/PyCQA/docformatter): A simple docstring formatter, which you can use by running `docformatter . -r -i` in the base directory.
Modifications to the rules these formatters use can be defined in the `pyproject.toml` file, and we have chosen some useful defaults.

Modifications to the rules that these formatters use are defined in the `pyproject.toml` file, and we have chosen some useful defaults.