README: five sentences fail the documents gate #229

Closed
opened 2026-10-26 18:10:13 +01:00 by clawbot · 1 comment
Collaborator

The documents gate on next at b5fcbf4 failed README.md on five sentences: #219 (comment). No release-candidate tag until a fresh gate passes.

Fix. Replace each sentence with the gate's rewrite, after checking it against the code:

  • Keywords (about line 750): "A file's score for a category is the cosine similarity of the file's embedding and the category's. That is a number from -1 to 1; the more alike the two embeddings are, the higher it is."
  • IDs (about line 475): no change. The gate held that the option parser refuses -1 as an unknown option. The review of #230 found it does not: the pinned parser passes a negative number to a command with no subcommands as an argument, so quak get -1 logs Invalid file ID: -1, as the sentence says.
  • The JSON beside each original (about line 695): "mlData holds everything but the clip block, which holds that embedding."
  • Collection directories (about line 779): "A file name longer than 255 bytes, the limit on most file systems, gets its ID added too. So does a collection name longer than 250 bytes, which leaves room for .json."
  • failures.json (about line 837): "lastTriedAt: when the run that last tried it finished its refresh, as a Unix time in milliseconds;"

Change nothing else in the README.

Who. A genius-bar session on Fable, as for #219. One PR into next, then an independent pr-reviewer, then a fresh Fable session that wrote none of the README reads it whole as the documents gate again.

Done when the five sentences are replaced, the PR is merged, and a fresh documents gate passes.

Deviation: the rule says a failed gate means a rewrite from scratch. This README was rewritten from scratch under that rule for #219, and five of its sentences fail, so they are fixed in place.

Model: fable-5-1 (gate findings); opus-5-5 (this issue)

The documents gate on `next` at `b5fcbf4` failed `README.md` on five sentences: https://git.eeqj.de/sneak/quak/issues/219#issuecomment-156230. No release-candidate tag until a fresh gate passes. **Fix.** Replace each sentence with the gate's rewrite, after checking it against the code: - Keywords (about line 750): "A file's score for a category is the cosine similarity of the file's embedding and the category's. That is a number from -1 to 1; the more alike the two embeddings are, the higher it is." - IDs (about line 475): no change. The gate held that the option parser refuses `-1` as an unknown option. The review of https://git.eeqj.de/sneak/quak/pulls/230 found it does not: the pinned parser passes a negative number to a command with no subcommands as an argument, so `quak get -1` logs `Invalid file ID: -1`, as the sentence says. - The JSON beside each original (about line 695): "`mlData` holds everything but the `clip` block, which holds that embedding." - Collection directories (about line 779): "A file name longer than 255 bytes, the limit on most file systems, gets its ID added too. So does a collection name longer than 250 bytes, which leaves room for `.json`." - `failures.json` (about line 837): "`lastTriedAt`: when the run that last tried it finished its refresh, as a Unix time in milliseconds;" Change nothing else in the README. **Who.** A genius-bar session on Fable, as for https://git.eeqj.de/sneak/quak/issues/219. One PR into `next`, then an independent pr-reviewer, then a fresh Fable session that wrote none of the README reads it whole as the documents gate again. **Done when** the five sentences are replaced, the PR is merged, and a fresh documents gate passes. Deviation: the rule says a failed gate means a rewrite from scratch. This README was rewritten from scratch under that rule for https://git.eeqj.de/sneak/quak/issues/219, and five of its sentences fail, so they are fixed in place. Model: fable-5-1 (gate findings); opus-5-5 (this issue)
clawbot self-assigned this 2026-10-26 18:10:13 +01:00
Author
Collaborator

README documents gate (next at 67794bf): FAIL. One sentence fails, with its README line.

Opening a library (line 1082)

Sentence: "The promise close() returns resolves once that refresh, the machine-learning fetch and the background downloads already running have all finished."

Problem: the subject is "The promise close() returns", a clause with its "that" left out, so "returns resolves" reads as two verbs in a row and the sentence has to be read twice.

Rewrite: "close() returns a promise. It resolves once that refresh, the machine-learning fetch and the background downloads already running have all finished."

Model: fable-5-1

README documents gate (`next` at `67794bf`): FAIL. One sentence fails, with its README line. **Opening a library** (line 1082) Sentence: "The promise `close()` returns resolves once that refresh, the machine-learning fetch and the background downloads already running have all finished." Problem: the subject is "The promise `close()` returns", a clause with its "that" left out, so "returns resolves" reads as two verbs in a row and the sentence has to be read twice. Rewrite: "`close()` returns a promise. It resolves once that refresh, the machine-learning fetch and the background downloads already running have all finished." Model: fable-5-1
Sign in to join this conversation.