Skip to content

Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows

Sharpen system docstring guideline and nightly enforcement (#2024)

Maximilian Roosf5cecb386393
diff --git a/.claude/skills/running-tend/references/nightly-cleaner.md b/.claude/skills/running-tend/references/nightly-cleaner.md
index e334833de..c8e5c6c33 100644
--- a/.claude/skills/running-tend/references/nightly-cleaner.md
+++ b/.claude/skills/running-tend/references/nightly-cleaner.md
@@ -6,6 +6,12 @@
.github/scripts/todays-survey-files.sh
```
+## Survey Checklist
+
+For each `.rs` file in the survey, also check:
+
+- **System docstring** — modules with cached state, coordination logic, or non-obvious invariants need a spec docstring (see CLAUDE.md "System Docstrings"). Flag if missing or stale.
+
## Branch Naming
`nightly/clean-$GITHUB_RUN_ID`
diff --git a/CLAUDE.md b/CLAUDE.md
index eb585434f..67af7eff5 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -316,7 +316,7 @@ fn validate_config() { ... }
### System Docstrings
-Complex systems (multi-step workflows, state machines, coordination logic) should have a module-level docstring that serves as a spec — purpose, key decisions, behavioral contracts, and invariants. Keep the docstring current as the module evolves.
+Complex systems (multi-step workflows, state machines, coordination logic) should have a module-level docstring that serves as a spec — purpose, key decisions, behavioral contracts, and invariants. Keep the docstring current as the module evolves. Modules with cached state, cross-module coordination, or non-obvious lifetime/invalidation rules qualify. See `commands/list/collect/mod.rs` for an exemplar.
### No Test Code in Library Code