Skip to content

Commit 16ee837

Browse files
authored
docs(agents): drop the retired paragraphs and keep the canonical ones verbatim (#125)
modern-python/.github#93: the three retired conventions (real work not scheduled, the INVARIANT: docstring shape, the # ty: ignore note) are process notes the standard no longer carries. modern-python/.github#92: section 9 of the standard fixes the justfile and README-links paragraphs word for word.
1 parent 8831c1d commit 16ee837

1 file changed

Lines changed: 1 addition & 9 deletions

File tree

‎AGENTS.md‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -65,27 +65,19 @@ parallelism: they run under the GIL for coverage, but the proof comes from the f
6565

6666
## Workflow
6767

68-
Real work **not scheduled** becomes a GitHub issue.
69-
7068
Every link in `README.md` must be absolute: `https://github.com/modern-python/<repo>/blob/main/<path>`,
7169
or `.../tree/main/<path>` for a directory. Never a relative path: `README.md` is also the PyPI long
7270
description, and PyPI does not rewrite relative links, so a relative one 404s on the package page.
7371

74-
An invariant is a test whose name is the claim, with a docstring opening `INVARIANT:` and a second
75-
paragraph naming **what breaks it** — design rationale, not a report of what this one test catches;
76-
a sibling test may be the one that trips.
77-
7872
## Code Style
7973

8074
- Design principle: thin wrapper, small public surface. `httpware.__all__` is checked against an
8175
explicit expected set in `tests/test_public_api.py`, so a symbol cannot appear unnoticed
8276
- `Http` is two letters in a class name (`AsyncClient`, not `ASYNCClient`); no `a` prefix on async
8377
methods, matching `httpx2` — `aclose()` is the sole exception
84-
- Type suppressions are `# ty: ignore[<rule>]`, never `# type: ignore`: this project checks with
85-
`ty`, which silently accepts the latter without checking the rule
8678
- Docstrings: public API documents the contract; internal helpers get a one-line contract, plus at
8779
most 1–2 lines for a genuinely non-obvious constraint. Never narrate implementation or justify
88-
code to a reviewer — cross-file rationale lives in an `INVARIANT:` test docstring
80+
code to a reviewer — cross-file rationale lives in an invariant test's docstring
8981

9082
## Agent skills
9183

0 commit comments

Comments
 (0)