docs: correct six claims the code had outgrown - #671
Merged
Merged
Conversation
This was referenced Sep 13, 2026
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.
Summary
#662's five stale claims, plus #661's missing constraint — one PR because they touch the same
two files for the same reason:
keyis documented in the README and in the inventory hosttable, and #661 itself says so ("…and the host table in
docs/design/inventory.mdif that oneis corrected under its own issue").
Each re-verified against
developbefore being changed:docs/language.md:3-5as <user>"as <user>,on,parallel,override def, the inventory syntaxdocs/language.md:28when/tags"whenis not a keyword — zero occurrences ininternal/lang; the sentence now says what actually happensdocs/design/inventory.md:16-19address| yes; nolocal, nointerpreteraddressrequired unlesslocal, and the table carrieslocal,interpreterand the free-form-variable rowinternal/inventory/inventory.go:1-3Varsis a field, andlang.ParseInventoryshippedinternal/std/postgres/postgres.shellf:1-7postgres.configwould inherit an unresolved problempostgres.configthat resolves itREADME.md:78,:115key:as an ordinary overrideFound while fixing it
README.md:115said "Onlyaddressis required" three lines above "host self = { local: "true" }(noaddressneeded)" — the same contradiction as the design doc's table, in the filethat had already been reviewed twice today. Corrected in the same sentence.
Not changed, deliberately
docs/dogfood.md:99— "A plan cannot read another host's inventory entry" — is superseded byADR-0054 and stays as written. That file is a dated report of what a deployment could not
express, and history is allowed to describe a world the code has left (ADR-0001). It gains a
forward pointer saying where the finding went, which is what #662 asked for.
Test plan
Doc and comment changes only. Each validation criterion from the issue, checked:
go test ./...,test/lint.sh,test/changelog-rule.sh,test/changelog-frozen.shgreen.Closes #661
Closes #662