document-auditor classes a same-reader restatement two ways #83
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Location:
.agents/agents/document-auditor.md, the paragraph that sorts passages into kinds (lines 27 to 38).Evidence: the brief calls a passage that answers a question another document already answers for the same reader a duplicate, whose edit links to the home or deletes the passage. Its last sentence calls text that breaks "any other rule of the Documentation or Writing section" a rule finding, whose edit is the smallest one that meets the rule. The Documentation section's one-home rule, "Give each rule or fact one home; elsewhere link to it instead of restating or excerpting it", is one of those rules, and the brief doesn't set it aside. So the same passage is both a duplicate and a rule finding, and the brief otherwise gives each passage one kind.
Scenario: two audits of the same README meet an install step restated from the contributor guide. One reports it as a duplicate, citing its home. The other reports it as a rule finding, citing the one-home rule. The edits agree, but the kinds and counts differ, and a design that answers the audit has to reconcile them.
Smallest fix: set the rule aside where the brief defines rule findings, such as "any other rule of the Documentation or Writing section, the one-home rule aside, is a rule finding".
Seen at:
01238ed. The same overlap held beforec736207reworded the sentence.