docs: adapt the comment style guide to this repo, and sweep - #98
Merged
Conversation
The guide cited files, documents and command packages from another repository, so two of its sections described a layout this tree does not have. Its rules are unchanged; the examples, the cross-reference targets and the per-package guidance now name what is here, and the transform example is a comment from this sweep. The sweep drops what the rules forbid and keeps what they are for. Every narrative sentence carried a fact, and the fact stays: the packages an SDK puts an inline request body in, the three ways a generated indexer spells a hop, why an envelope cannot be taken as the element. What goes is the account of how each was found, the counts measured on one run, and the asides. No behaviour change. unsupported.json is byte-identical on all three pilots and every tree reproduces without drift. 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
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.
CLAUDE.mdrequires comments to say what and why and nothing else, anddocs/comment-style.mdis the long form of that rule. The tree had never beenswept against it.
First, the guide describes this repo
It arrived citing
internal/hcs/netmodes.go,internal/hcs/reconcile.go,docs/backends.md,internal/command,cmd/hcsspike, and gate/milestone ids —none of which exist here. Two sections therefore described a layout this tree
does not have.
The rules are unchanged. What changed is everything that pointed elsewhere:
union as a composed type with one named accessor per branch"), and the tabular
blocks cited are
internal/corpus/cache.goandinternal/sdkbind/binder_kiota.go, which really carry them.docs/contract.md,docs/glossary.md,docs/mapping.md,x-tfpfgen-*keys,TFPFGEN_*variables.pull request changed it, both of which
CLAUDE.mdnames and the guide didnot.
sweep (
joinTreeKeeping) rather than one about a Windows guest agent.internal/cli,cmd/tfpfgen, and a newentry for
internal/templates: a template's comments are emitted intosomebody else's repository, where nobody can edit them, so they say what the
generated code does and never how this toolkit decided to generate it.
docs/backends.md; it now points atthe pull request body and commit messages, where a measurement carries a date.
Then the sweep
Every narrative sentence carried a fact, and the fact stays. What goes is the
account of how it was found. Seventeen files:
models, and the exact failure textByGist_id,ByOwnerId,ByEnterpriseTeamId)-allow-conflictstaught that"go testmakes that fatalCLAUDE.mdforbids "war stories about a previous version" explicitly, which iswhat the six
v1references were. Each stated a real constraint; each keeps it.Also removed: two editorial asides ("Not a nicety", "which is the point").
Templates were checked and left alone — their
tfpfgenreferences correctly tella generated-repo reader where to make changes, which is what those comments are
for.
Measured effect
None, and that is the acceptance test.
unsupported.jsonisbyte-identical on all three pilots, verified with
diff:tfpfgen provider verify— no drift on all three (3358 / 2935 / 1420 files).Gates
gofmt -l internal cmd— emptyscripts/repo_hygiene_gate.sh— passgolangci-lint run— 0 issuesgo build ./... && go vet ./...— passgo test ./...— pass, coverage 91.4% total🤖 Generated with Claude Code