docs: fix godoc rendering and restore full AGENTS.md mirror - #80
Conversation
- Restore AGENTS.md as a full, agent-neutral mirror of CLAUDE.md with cross-references so the two files stay in sync - Replace the stale backward-compatibility rule with the version 0 policy and a docs-update checklist naming the real doc surfaces - Rejoin batch/doc.go's package comment so the batching priority rules render on pkg.go.dev again, and correct the batch-timing sentence (windows open at dispatch, not when the previous batch finishes) - Remove the duplicate package comment in batch/config.go - Document Config.Get accurately: Batch normalizes values via fixConfig; a zero MaxItems/MaxTime means no maximum applies - Indent dash lists in batch, processor, and source docs so godoc renders them as lists instead of run-on paragraphs - Drop processor/doc.go's blanket context-cancellation claim (Transform, Filter, and Error do not check ctx) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #80 +/- ##
==========================================
- Coverage 96.79% 96.73% -0.06%
==========================================
Files 12 12
Lines 374 368 -6
==========================================
- Hits 362 356 -6
Misses 9 9
Partials 3 3 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation across several files, including AGENTS.md, CLAUDE.md, and package-level doc files. Key updates include renaming ChatGPT instructions to Agent Instructions, documenting that breaking changes are acceptable on master for this version 0 library, updating key concepts to use generic types (e.g., Batch[T]), and clarifying configuration normalization and concurrent batch processing behavior. There are no review comments, and I have no feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
The suite has scheduler-dependent paths, so total coverage varies slightly between identical runs; the default 0% threshold fails doc-only PRs on measurement noise. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 participant
Summary
doc.gofiles and the example tests); added[T]to the Key Concepts to match the post-generics API; fixed the missing trailing newlineMaxTime = MaxItems > EOF > MinTime > MinItems) and worked examples were silently absent from pkg.go.dev; corrected the batch-timing sentence (windows open when the previous batch is dispatched, and batches process concurrently — not "when the previous batch finished processing")Config.Getaccurately — implementations return values as provided,Batchnormalizes them, and a zeroMaxItems/MaxTimemeans no maximum appliesbatch/doc.go,processor/doc.go,source/doc.go, andNewDynamicConfigso they render as lists instead of run-on paragraphscodecov/projectstatus — the suite has scheduler-dependent paths, so total coverage varies slightly between identical runs, and the default 0% threshold failed this doc-only PR on −0.06% measurement noiseDoc/comment-only change apart from the codecov config — no behavior changes.
Test plan
gofmt -l .clean,go vet ./...cleango test -race -covermode=atomic ./...passes (batch 98.4%, processor 98.2%, source 95.8%)go doc ./batch,go doc ./processor,go doc ./source,go doc ./batch Config, andgo doc ./batch NewDynamicConfigcodecov.ymlvalidated againsthttps://codecov.io/validate; all four checks green on the final head (build 1.25.x/1.26.x, codecov/patch, codecov/project)🤖 Generated with Claude Code