docs: correct stale claims in MEMORY.md, TODO.md, and README.md (closes #3)
Four documented claims had gone false and were actively misdirecting agents working this repo; the independent reviewer on PR #9 repeated one of them verbatim. Each claim was re-verified against the tree before rewriting. MEMORY.md "Error handling" described C's exit() calls being unwound by a gameEnd panic recovered in Run. Refactor step 8 removed that: gameEnd appears nowhere in the sources, myExit (game/rip.go) restores the terminal via Terminal.Fini and calls os.Exit(0), and Run() has no return values and never returns. The section now states that model and its testing consequence -- a death exits the test binary, which is why tests drive command() directly and crash sweeps pin the hero with fortify() in game/run_test.go. MEMORY.md "Linting" said approved exceptions are recorded in a "Repo-specific exceptions" block in .golangci.yml. There is no such block: the config is byte-identical to canonical (sha256 021cc83f...46bcb) and the approvals live in in-code //nolint directives carrying their dates. Following the old text would have meant editing the canonical config. The same paragraph listed paralleltest as an approved disable when it was fixed instead -- no paralleltest token exists in the tree and all 32 tests call t.Parallel(). MEMORY.md "Debugging" and README.md both told the reader to run go test directly. Since PR #9 the test target carries -timeout 30s -race -cover, so a raw invocation silently drops the race detector while appearing to verify the change. Both now point at make test / make check. TODO.md asserted the host golangci-lint is "currently v2.12.2". It is v2.10.1 and the repo pins nothing, so the claim documented an accident of one machine. Only the false claim is removed; the pin question is tracked separately. Documentation only: no code, Makefile, or config change. Next Step is deliberately not rotated, per the precedent for out-of-band issue work.
This commit is contained in:
25
TODO.md
25
TODO.md
@@ -34,6 +34,29 @@ wizard commands).
|
||||
|
||||
# Completed Steps
|
||||
|
||||
- 2026-08-09 Stale-docs correction (`docs-staleness`, closes #3): four claims in
|
||||
`MEMORY.md`/`TODO.md`/`README.md` had gone false and were misdirecting agents
|
||||
— the reviewer on PR #9 repeated one of them verbatim. Each was re-verified
|
||||
against the tree before rewriting. (1) `MEMORY.md` described C's `exit()`
|
||||
being unwound by a `gameEnd` panic recovered in `Run`; refactor step 8 deleted
|
||||
that, `gameEnd` appears nowhere in the sources, and `myExit` (`game/rip.go`)
|
||||
now calls `Terminal.Fini` then `os.Exit(0)` while `Run()` never returns — so
|
||||
the section states the exit model and its testing consequence (a death exits
|
||||
the test binary; hence `fortify()` in `game/run_test.go`). (2) `MEMORY.md`
|
||||
said approved lint exceptions live in a "Repo-specific exceptions" block in
|
||||
`.golangci.yml`; no such block exists and the config is byte-identical to
|
||||
canonical (sha256 `021cc83f…46bcb`), the approvals having moved to in-code
|
||||
`//nolint` directives carrying their dates — and `paralleltest` was listed as
|
||||
an approved disable when it was in fact fixed (no `paralleltest` token in the
|
||||
tree; 32 `t.Parallel()` calls against 32 tests). (3) `MEMORY.md` "Debugging"
|
||||
and (4) `README.md` both told the reader to run `go test` directly, which
|
||||
since PR #9 silently drops `-timeout 30s -race -cover`; both now point at
|
||||
`make test`/`make check`. Also dropped the false "currently v2.12.2" host
|
||||
linter claim from the 2026-08-07 entry (the host is v2.10.1 and nothing is
|
||||
pinned; the pin question is tracked separately). Documentation only — no code,
|
||||
`Makefile`, or config change; `Next Step` deliberately not rotated, since this
|
||||
was out-of-band issue work.
|
||||
|
||||
- 2026-08-09 Policy-shaped `make test` (`make-test-policy-pattern`): the `test:`
|
||||
target was a bare `go test $(GO_PKGS)` and now runs
|
||||
`-timeout 30s -race -cover` with the mandated conditional verbose rerun (on
|
||||
@@ -58,7 +81,7 @@ wizard commands).
|
||||
24 long lines wrapped or their comments tightened, control bytes in
|
||||
`term/tcell.go` as character literals, and two `wsl_v5` defer cuddles. The
|
||||
repo has no golangci-lint version pin to bump (no Dockerfile or CI;
|
||||
`make lint` runs the host `golangci-lint`, currently v2.12.2).
|
||||
`make lint` runs whatever `golangci-lint` is on the host).
|
||||
|
||||
- 2026-07-24 Seed compatibility — item tables (seed-compat): instrumented the C
|
||||
reference on modern-rogue with a DUMP mode (testdata/c_seedcompat.patch) that
|
||||
|
||||
Reference in New Issue
Block a user