Skip to content

Commit 370de3b

Browse files
authored
docs: plain-prose pass over agent and glossary docs (#267)
1 parent b674cf6 commit 370de3b

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

‎AGENTS.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,30 @@ contributor traffic: most merged PRs come from someone other than the maintainer
66
Assume a human reviews your diff.
77

88
`modern-di` is the newer framework from the same author, and this repo links to it, but
9-
`that-depends` is actively maintained rather than deprecated. Do not rewrite anything
9+
`that-depends` is still actively maintained. Do not rewrite anything
1010
here toward `modern-di`'s design, and do not carry conventions across in either
11-
direction — the two repos diverge deliberately.
11+
direction; the two repos diverge deliberately.
1212

1313
## Commands
1414

1515
`just` (task runner) and `uv` (package manager). The [`justfile`](justfile) is the
16-
source of truth — `just --list`, or read it. Two behaviours to know before running
16+
source of truth: run `just --list`, or read it. Two behaviours to know before running
1717
anything:
1818

1919
- `just lint` **rewrites files**. `just lint-ci` is the read-only twin and is what CI
20-
runs. Use `lint-ci` when you want an answer rather than a mutation.
20+
runs. Use `lint-ci` when you only want to check.
2121
- `just install` also installs the [`.pre-commit-config.yaml`](.pre-commit-config.yaml)
2222
hooks, so committing can change your working tree before the commit lands.
2323
`just unhook` removes them.
2424

25-
Type checking is **two** checkers — `mypy` in strict mode and `pyrefly` — and both must
25+
Type checking is **two** checkers, `mypy` in strict mode and `pyrefly`, and both must
2626
be clean. There is no `ty` here, despite the org-level tooling note.
2727

2828
## Docs
2929

3030
Docs are MkDocs Material, but **Read the Docs builds and hosts them**
31-
([`.readthedocs.yaml`](.readthedocs.yaml) → `docs/requirements.txt` → `mkdocs.yml`) —
32-
not the GitHub Pages workflow the rest of the org uses. Two consequences:
31+
([`.readthedocs.yaml`](.readthedocs.yaml) → `docs/requirements.txt` → `mkdocs.yml`),
32+
unlike the rest of the org, which uses the GitHub Pages workflow. Two consequences:
3333

3434
- **Nothing builds the docs in CI.** A broken link or a bad snippet lands on `main` and
3535
only surfaces in the Read the Docs build afterwards. `just docs` serves the site
@@ -62,7 +62,7 @@ single-file read will not tell you:
6262
`_ContainerMetaDict.__setitem__` reads it while the class body is still executing and
6363
raises `DefaultScopeNotDefinedError` otherwise. Statement order inside the class body
6464
is load-bearing.
65-
- **Every public operation has a sync and an async twin** — `resolve`/`resolve_sync`,
65+
- **Every public operation has a sync and an async twin**: `resolve`/`resolve_sync`,
6666
`override`/`override_sync`, `tear_down`/`tear_down_sync`,
6767
`context_async`/`context_sync`. Adding one half of a pair is an incomplete change.
6868

@@ -90,7 +90,7 @@ Every link in `README.md` must be absolute: `https://github.com/modern-python/<r
9090
or `.../tree/main/<path>` for a directory. Never a relative path: `README.md` is also the PyPI long
9191
description, and PyPI does not rewrite relative links, so a relative one 404s on the package page.
9292

93-
Unlike the rest of the org, **you are not the last reader of your diff** — a second
93+
Unlike the rest of the org, **you are not the last reader of your diff**: a second
9494
party reviews and merges it. Write for them: what changed, why, and what you chose not
9595
to do. Keep one PR to one thing.
9696

@@ -100,13 +100,13 @@ work.
100100

101101
This repo has no `docs/adr/` and no `CONTEXT.md`. A decision that outlives the PR goes
102102
in [`docs/dev/main-decisions.md`](docs/dev/main-decisions.md), which is a **user-facing
103-
page** — write it for a reader of the docs site, not as an internal record. Issues live
103+
page**: write it for a reader of the docs site, not as an internal record. Issues live
104104
on `modern-python/that-depends` itself (`gh issue create`), not on the org repo.
105105

106106
## Releases
107107

108108
`pyproject.toml` carries `version = "0"` as a placeholder. The published version comes
109-
from the git tag — publishing triggers on a GitHub release and `just publish` runs
109+
from the git tag: publishing triggers on a GitHub release and `just publish` runs
110110
`uv version $GITHUB_REF_NAME`. **Never hand-edit `version`**; cut a release instead.
111111

112112
## Code style

0 commit comments

Comments
 (0)