File tree Expand file tree Collapse file tree 2 files changed +15
-0
lines changed
Expand file tree Collapse file tree 2 files changed +15
-0
lines changed Original file line number Diff line number Diff line change 1+ - Only generate docstrings for public functions or functions that contain more than 4 lines of code.
2+ - Use the Sphinx style for Python docstrings (e.g. : param my_param: Does something) and never
3+ include a :returns: key.
4+ - The code you generate should always contain type hints in the function prototypes (including
5+ return type hints of None), but type hints are not needed when initializing variables.
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+ - After generating code, please run ` uv run ty check ` , ` uv run ruff check ` and ` uv run ruff format ` .
10+ Fix any error.
11+ - After changing anything in ` src ` or in ` tests/unit ` or ` tests/doc ` , please identify the affected
12+ test files in ` tests/ ` and run them with e.g.
13+ ` uv run pytest tests/unit/aggregation/test_upgrad.py -W error ` . Fix any error, either in the
14+ changes you've made or by adapting the tests to the new specifications.
Original file line number Diff line number Diff line change 1+ @AGENTS .md
You can’t perform that action at this time.
0 commit comments