Skip to content

Commit

Permalink
Update linting.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew-S-Rosen authored Nov 18, 2024
1 parent fb1add5 commit 0d526ea
Showing 1 changed file with 2 additions and 8 deletions.
10 changes: 2 additions & 8 deletions docs/example_docs/other/linting.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,5 @@

## Overview

When you installed the `[dev]` dependencies, you installed several code-formatting and linting tools, including:

1. [`black`](https://black.readthedocs.io/en/stable/): A very useful and opinionated code formatter, which you can use by running `black .` in the base directory.
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.
When you installed the `[dev]` dependencies, you also installed [`ruff`](https://docs.astral.sh/ruff/), which is a versatile Python linter to clean up your code.
To run `ruff`, use the following command in the base directory: `ruff check --fix`

0 comments on commit 0d526ea

Please sign in to comment.