fix: require a delimiter for bare TODO/FIXME markers#144
Merged
Conversation
The open-questions marker scan grounded evidence/open-questions with a
pattern that admitted a bare uppercase TODO or FIXME followed by
whitespace or end-of-line. On a repository that documents its own
conventions every prose mention of a marker then matched: 18 false
positives across this repo's durable record, all documentation about
markers, none a real work marker.
Split the marker set by trailing boundary: TODO and FIXME now require a
trailing ':' or '(' (the conventional TODO: and TODO(alice): spellings,
how genuine markers are almost always written); XXX, HACK, and BUG keep
their bare-word form, since they are rarely written as bare uppercase
words in prose and dropping it would lose real recall for no measured
precision gain. This kills 100% of the bare-word documentation
false-positive class while preserving every colon-form fixture marker.
spc-12's pattern description moves in the same change. The pinning test
gains the prose-mention reject cases and a probe-level test proving a
repo whose prose merely names markers stays blank.
Assisted-by: Claude:claude-opus-4-8
The marker-pattern false-positive fix landed in the preceding commit; move the issue to resolved/ with the measured numbers and a fix impact. Assisted-by: Claude:claude-opus-4-8
Review found two factual-accuracy defects in the iss-111 fix's prose: 1. The "18 false positives" figure did not reproduce. Re-measured the old pattern against the base-commit tree, scoped explicitly to the durable record (.abcd/development/): 14 before, 3 after. Corrected the figure and named the scope in the CHANGELOG entry and the resolved iss-111 note. 2. The new doc-comments naming XXX/HACK/BUG and the TODO: spelling were themselves bare-word / delimited marker tokens, so the scan self-cited its own prose (the file went 2 -> 3 self-citations). Reworded so the comments name the markers only as slice values, not inline; the file's self-match count is now 0 (verified by re-running the pattern over the file). No behaviour change: the pattern, tests, and spec are untouched. Assisted-by: Claude:claude-opus-4-8
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.
Fixes ledger issue iss-111 (minor): the open-questions marker pattern matched bare uppercase marker words followed by whitespace, so prose that merely mentions a marker was cited as a work marker — on this repository's durable record (
.abcd/development/), 14 such false citations, every one documentation about markers.Chained PR: base is
fix/iss-117-impact-write-paths(#136) — the ledger resolve uses that branch's--impactverb. Only #136 gates this; GitHub retargets on its merge. Sibling PR (the WalkFiles class) shares the same base.What changed
:or(), XXX/HACK/BUG keep the bare form. Both options kill the same false-positive class; this one loses strictly less genuine recall (the bare XXX/HACK/BUG spellings survive).TODO:with its colon and are irreducible under either recorded option (reported to the orchestrator and captured separately). Fixture recall for the conventional spellings is fully preserved; two bare fixtures (# TODO,* FIXME check this) are deliberately reclassified as rejects — they are structurally the false-positive class itself.Verification
blank) both watched to fail against the old pattern; the integration test drives the real adapter.make preflightexit 0,record-lintexit 0.impact: fix.