docs: reconcile the documentation with the code
An audit of every document against the source turned up drift that had accumulated since the 1.0.2 passes. The screenshot paths README and DEVELOPMENT still point at are deliberately left alone - the images move again when they are retaken. ARCHITECTURE: the jobs_view.go split is six files, not five, since extracting jobs_view_state.go was never counted; the statistics table lists TimedRunCount, which the AvgDurationMS formula already referenced; the store edge of the diagram names methods that exist (LoadJobs and LoadConfig never did); and startup says that Service.Start is called from newMainView rather than from Run. TESTS: three tests had no entry, the latter two being regression tests for 1.0.2 fixes: TestLoadOrCreateConfigPreservesZeroRetentionLimits TestWriteJSONReplacesFileAtomically TestQuoteLeadingWindowsProgramPathPicksEarliestBoundedExtension The deliberately-uncovered list now covers everything the profile actually reports at 0%, so the next redundancy pass does not flag Config, Paths, SaveJobs, or the isEvent markers as gaps. The coverage section measures through -coverprofile and says outright that the per-package percentages -coverpkg prints are not the total - 2.6/8.9/25.5/1.0/61.5 against a real 84.1%. ROADMAP: the over-the-guideline table was re-measured (service.go is over it too now, making six), with a note to re-measure rather than trust it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
@@ -74,6 +74,17 @@ the app icon (experimental).**
|
||||
- **`docs/ARCHITECTURE.md`** — new §Platform layer: why autostart, file manager,
|
||||
shell, and winproc are OS-specific; compile-time vs runtime branching; rules
|
||||
for adding platform code.
|
||||
- Documentation audited against the code. `ARCHITECTURE.md` — the `jobs_view.go`
|
||||
split is six files, not five (the state extraction was never counted), the
|
||||
statistics table lists `TimedRunCount`, the store edge of the diagram names
|
||||
the methods that exist, and startup says where `Service.Start` is actually
|
||||
called. `TESTS.md` — three tests that had no entry are described
|
||||
(`TestLoadOrCreateConfigPreservesZeroRetentionLimits`,
|
||||
`TestWriteJSONReplacesFileAtomically`,
|
||||
`TestQuoteLeadingWindowsProgramPathPicksEarliestBoundedExtension`), the
|
||||
deliberately-uncovered list covers everything the profile reports at 0%, and
|
||||
the coverage figure records how to read the total rather than the per-package
|
||||
lines. `ROADMAP.md` — the over-the-guideline table was re-measured.
|
||||
|
||||
**Internal:**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user