tidy-discovery: a package doc that rendered as a code block - #276
Merged
Conversation
The opening sentence was split across three comment blocks with its middle third indented by a tab, so godoc rendered "/ 7.2 — full, grouped and lazy — plus the lexical ranker, the" as a code block wedged between two prose fragments. The "/ 7.2" is residue of a section citation that was removed without the slash, the same shape repaired in internal/scope's package doc. One paragraph now, and `go doc ./internal/discovery` prints it as prose. While there: itoa's comment claimed the grouped-mode collision suffix was its only user. query.go has three call sites and describe.go one, all building frozen error messages, which is the reason worth recording — those sentences are assembled by concatenation alone and so stay trivially identical to their golden files. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Nightly tidy pass, 2026-08-10 00:17 round. Two slices were opened; the first
produced nothing.
internal/ratelimit— quiet, nothing landed. Read end to end (doc,limiter, admission, config, governance, state). All three passes came up
empty, and the doc's claims check out, including "the production wiring is
internal/gateway/ratelimit.go" and "an assembly is expected to wire Loggerand OnEvent" — the gateway wires Store, Logger and OnEvent. The branch was
discarded rather than filled.
internal/discovery— this PR.blocks with its middle third tab-indented, so
go docrendered it as acode block. The stray
/ 7.2is residue of a removed section citation,the same shape repaired in
internal/scopeearlier tonight.itoa's comment said collision suffixes were its onlyuser;
query.gohas three call sites anddescribe.goone.Verification:
make cigreen;go doc ./internal/discoverynow prints prose.