Skip to content

Commit 29bb650

Browse files
committed
docs(agents): drop the retired paragraphs and keep the canonical ones verbatim
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 d77178c commit 29bb650

1 file changed

Lines changed: 1 addition & 6 deletions

File tree

‎AGENTS.md‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ concept in code, a test name, or an issue title.
1212
## Commands
1313

1414
`just` (task runner) and `uv` (package manager). The [`justfile`](justfile) is the source of truth —
15-
`just --list`, or read it; every recipe carries its intent as a comment. The one thing it does not
15+
`just --list`, or read it. Every recipe carries its intent as a comment. The one thing it does not
1616
say: **never run bare `ruff check`** — `[tool.ruff]` sets `fix = true` and `unsafe-fixes = true`, so
1717
an unqualified invocation rewrites the tree.
1818

@@ -35,15 +35,10 @@ for what it does; read them. What reading a single module will **not** tell you:
3535

3636
## Workflow
3737

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

44-
An invariant is a test whose name is the claim, with a docstring opening `INVARIANT:` and a second
45-
paragraph naming **what breaks it** — design rationale, not a report of what this one test catches.
46-
4742
## Code Style
4843

4944
- The core package stays **zero-dependency**; PyYAML is the optional `[yaml]` extra and nothing else

0 commit comments

Comments
 (0)