docs(readme): drop an ordinal that counted the deleted console - #767
Open
eaitbrahim wants to merge 1 commit into
Open
docs(readme): drop an ordinal that counted the deleted console#767eaitbrahim wants to merge 1 commit into
eaitbrahim wants to merge 1 commit into
Conversation
Review of this PR's own diff, and the finding is in the sentence the PR edits. "There is also a FOURTH way to read all of this: `keel mcp`..." entered at #600 (`git log -S`), in the same sentence as "the browser view and the TUI answer". The TUI was one of the three it counted from, so the count has been wrong since #541 -- and removing "and the TUI" from the next clause took away the last visible trace of what it referred to, leaving a reader an ordinal with no recoverable referent. Worse than before, in the exact way this PR is about. Dropped rather than renumbered. "Third" would rot the same way the moment a surface is added or retired, and nothing in the README enumerates the set, so no number in that position can be checked by the person reading it. Also, per the same review: RETIRED entries must be DISTINCTIVE tokens. The match is `\b<surface>\b` over whole documents, which is safe for `tui` and would be useless for something like `api` -- it would fire on every page and the next author would loosen the rule to escape the noise rather than fix a document. The note says to match the command (`keel <name>`) instead when the name is common. Checked while here: README.ar.md carries no equivalent claim, and no other "a <ordinal> way" survives in the README. 6,426 passed / 3 skipped, ruff clean. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KZZxmspQXe5qJ9FAsG13s6
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.
Follow-up to #766. The review finding on that PR was pushed to its branch after it merged, so it never reached
main— #766 merged at761a04d, the fix wasb74bdcc. This carries it over unchanged.The finding
README.mdsaid "There is also a fourth way to read all of this:keel mcp…".git log -S "fourth way to read"puts that phrase at #600, in the same sentence as "the browser view and the TUI answer" — so the TUI was one of the three it counted from. The count has been wrong since #541 deleted the command, and #766 removingand the TUIfrom the next clause took away the last visible trace of what it referred to.That left a reader an ordinal with no recoverable referent — worse than before, in exactly the way #766 was about.
Dropped, not renumbered
"Third" would rot the same way the moment a surface is added or retired, and nothing in the README enumerates the set, so no number in that position can be checked by the person reading it. The sentence now just introduces
keel mcp.Also carried over
RETIREDentries must be distinctive tokens, as a note intests/test_retired_surfaces.py. The match is\b<surface>\bover whole documents — safe fortui, useless for something likeapi, which would fire on every page and lead the next author to loosen the rule rather than fix a document. The note says to match the command form (keel <name>) when the name is common.Checks
README.ar.mdcarries no equivalent claim, and no othera <ordinal> waysurvives in the README. 6,426 passed / 3 skipped, ruff clean.🤖 Generated with Claude Code
https://claude.ai/code/session_01KZZxmspQXe5qJ9FAsG13s6