claims.md (1376B)
1 # Claims 2 3 You are given comment and documentation lines the change adds. Some of them assert 4 things about the world: how a system behaves, what a tool accepts, what a format 5 requires. Those assertions are the subject. 6 7 - `unsupported-claim` — the comment asserts an empirical fact about an external 8 system, and nothing in the change demonstrates it. Comments describing what the 9 code does are not claims; comments describing what Windows, macOS, a compiler or a 10 specification does are. 11 - `overreaches` — the claim is broader than what could have been observed. "Adding 12 lighting avoids the crash" from one passing case is a rule invented from an 13 instance. 14 - `cites-nothing-checkable` — the claim would need a source and gives none: no 15 version, no tool, no test that pins it. 16 - `stale` — the comment describes behaviour the change itself has altered. 17 18 These overlap. Where more than one fits, report the first that does and only that 19 one: a comment gets one finding. 20 21 A comment that is merely wordy is not a finding. Only judge assertions that could be 22 false. A comment saying what the code in front of it does is never a claim, however 23 confidently it says it. The code beneath each comment is shown so that `stale` can be 24 judged against what the change actually does, and so that a comment describing that 25 code is read as description rather than assertion.