Skip to content

Commit c6e8f1d

Browse files
authored
chore: Update AGENTS.md (#569)
1 parent 46962c2 commit c6e8f1d

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

AGENTS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
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`.
912
- After generating code, please run `uv run ty check`, `uv run ruff check` and `uv run ruff format`.
1013
Fix any error.
1114
- After changing anything in `src` or in `tests/unit` or `tests/doc`, please identify the affected

0 commit comments

Comments
 (0)