We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
AGENTS.md
1 parent 46962c2 commit c6e8f1dCopy full SHA for c6e8f1d
1 file changed
AGENTS.md
@@ -6,6 +6,9 @@
6
- We use uv for everything (e.g. we do `uv run python ...` to run some python code, and
7
`uv run pytest tests/unit` to run unit tests). Please prefer `uv run python -c ...` over
8
`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`.
12
- After generating code, please run `uv run ty check`, `uv run ruff check` and `uv run ruff format`.
13
Fix any error.
14
- After changing anything in `src` or in `tests/unit` or `tests/doc`, please identify the affected
0 commit comments