From d64f4589bba84c63cbec8419861c5bb281367718 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Val=C3=A9rian=20Rey?= Date: Sun, 15 Feb 2026 11:51:18 +0100 Subject: [PATCH] chore: Update AGENTS.md --- AGENTS.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index d08db835..78177b50 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -6,6 +6,9 @@ - We use uv for everything (e.g. we do `uv run python ...` to run some python code, and `uv run pytest tests/unit` to run unit tests). Please prefer `uv run python -c ...` over `python3 -c ...` +- When you create or modify a code example in a public docstring, always update the corresponding + doc test in the appropriate file of `tests/doc`. This also applies to any change in an example of + a `.rst` file, that must be updated in the corresponding test in `tests/doc/test_rst.py`. - After generating code, please run `uv run ty check`, `uv run ruff check` and `uv run ruff format`. Fix any error. - After changing anything in `src` or in `tests/unit` or `tests/doc`, please identify the affected