| @@ -156,14 +156,13 @@ To test, run: |
|
|
| 156 |
156 |
pytest |
| 157 |
157 |
``` |
| 158 |
158 |
|
| 159 |
|
-To lint, and apply automatic code formatting, run: |
|
159 |
+To lint, and apply some linting fixes as well as automatic code formatting, run: |
| 160 |
160 |
|
| 161 |
161 |
```sh |
| 162 |
162 |
pre-commit run --all-files |
| 163 |
163 |
``` |
| 164 |
164 |
|
| 165 |
|
-- Linting without modifying code can be done with: `make lint` |
| 166 |
|
-- Auto-formatting without other lint checks can be done with: `black .` |
|
165 |
+This includes the linting and autoformatting done by Ruff, as well as some other checks. |
| 167 |
166 |
|
| 168 |
167 |
To typecheck, run: |
| 169 |
168 |
|
| @@ -173,18 +172,20 @@ mypy -p git |
|
|
| 173 |
172 |
|
| 174 |
173 |
#### CI (and tox) |
| 175 |
174 |
|
| 176 |
|
-The same linting, and running tests on all the different supported Python versions, will be performed: |
|
175 |
+Style and formatting checks, and running tests on all the different supported Python versions, will be performed: |
| 177 |
176 |
|
| 178 |
177 |
- Upon submitting a pull request. |
| 179 |
178 |
- On each push, *if* you have a fork with GitHub Actions enabled. |
| 180 |
179 |
- Locally, if you run [`tox`](https://tox.wiki/) (this skips any Python versions you don't have installed). |
| 181 |
180 |
|
| 182 |
181 |
#### Configuration files |
| 183 |
182 |
|
| 184 |
|
-Specific tools: |
|
183 |
+Specific tools are all configured in the `./pyproject.toml` file: |
| 185 |
184 |
|
| 186 |
|
-- Configurations for `mypy`, `pytest`, `coverage.py`, and `black` are in `./pyproject.toml`. |
| 187 |
|
-- Configuration for `ruff` is in the `pyproject.toml` file. |
|
185 |
+- `pytest` (test runner) |
|
186 |
+- `coverage.py` (code coverage) |
|
187 |
+- `ruff` (linter and formatter) |
|
188 |
+- `mypy` (type checker) |
| 188 |
189 |
|
| 189 |
190 |
Orchestration tools: |
| 190 |
191 |
|