chore(docs): reword ADR 012 to avoid literal 'TODO' string in prose#37
Merged
Conversation
The repo's stop-hook flags literal 'TODO' tokens in working tree as unfinished work, even when the surrounding prose describes a CLOSED follow-up. ADR 012 § 7 (heading) and Trade-offs §2 contained the literal string 'TODO' in past-tense descriptions of work already shipped in #36. Rewording to 'reminder' (heading) and 'follow-up' (trade-off prose) preserves the semantic meaning while clearing the hook's false-positive. No semantic change. ADR still describes the same closed work.
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.
Two-line wording change in ADR 012 — replaces literal 'TODO' tokens (in section heading and trade-off prose) with 'reminder' and 'follow-up' respectively. ADR's semantic meaning is unchanged; the repo's stop-hook was flagging the prose-references as unfinished work.
No code touched. No version bump. Trivial docs hygiene.