Skip to content

Commit 39d4830

Browse files
authored
Corrections to develop.md
1 parent 17679de commit 39d4830

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

docs/develop.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,8 @@ ls .git/hooks | grep -v .sample # should now see a new pre-commit hook
3838
At the moment, we're using:
3939

4040
- [`ruff` and `ruff-format`](https://docs.astral.sh/ruff/) for python code formatting,
41-
- [nbstribout](https://github.com/kynan/nbstripout) to clear notebook output.
42-
- A small selection of line-endings fixers.
43-
41+
- [`mypy`](https://mypy.readthedocs.io/en/stable/) for static type checking,
42+
- [`docformatter`](https://github.com/PyCQA/docformatter) to format docstrings.
4443
If you want to run them individually you can do so with:
4544

4645
```
@@ -59,7 +58,7 @@ to use that for consistency).
5958
### Problems with pre-commit?
6059

6160
If the linters are flagging false positives, you can remove them or comment them
62-
out in [the configuration](./.pre-commit-config.yaml). If you've accidentally
61+
out in [the configuration](../.pre-commit-config.yaml). If you've accidentally
6362
commited something that is failing the linting step in CI, you can fix this
6463
with:
6564

@@ -85,12 +84,7 @@ From the repo root, install the software and its deps:
8584
```
8685
uv pip install -e '.[dev]'
8786
```
88-
89-
90-
### API tests
91-
92-
from PROJECT_ROOT directory
93-
94-
```shell script
95-
./tools/run-tests.sh
87+
Run tests with:
88+
```
89+
pyest
9690
```

0 commit comments

Comments
 (0)