Skip to content

Commit 017b778

Browse files
committed
Update instructions on doc testing
1 parent 9ef1301 commit 017b778

2 files changed

Lines changed: 2 additions & 6 deletions

File tree

AGENTS.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@
66
- We use uv for everything (e.g. we do `uv run python ...` to run some python code, and
77
`uv run pytest tests/unit` to run unit tests). Please prefer `uv run python -c ...` over
88
`python3 -c ...`
9-
- When you create or modify a code example in a public docstring, always update the corresponding
10-
doc test in the appropriate file of `tests/doc`. This also applies to any change in an example of
11-
a `.rst` file, that must be updated in the corresponding test in `tests/doc/test_rst.py`.
129
- After generating code, please run `uv run ty check`, `uv run ruff check` and `uv run ruff format`.
1310
Fix any error.
1411
- After changing anything in `src` or in `tests/unit` or `tests/doc`, please identify the affected

CONTRIBUTING.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,9 @@ uv run pre-commit install
9999
CUBLAS_WORKSPACE_CONFIG=:4096:8 PYTEST_TORCH_DEVICE=cuda:0 uv run pytest tests/unit
100100
```
101101

102-
- To check that the usage examples from docstrings and `.rst` files are correct, we test their
103-
behavior in `tests/doc`. To run these tests, do:
102+
- To check that the usage examples from docstrings and `.rst` files are correct, run:
104103
```bash
105-
uv run pytest tests/doc
104+
uv run make doctest -C docs
106105
```
107106

108107
- To compute the code coverage locally, you should run the unit tests and the doc tests together,

0 commit comments

Comments
 (0)