Fix the six README sentences the documents check failed #565

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

The documents check that comes before the next release-candidate tag failed README.md at e584718 on six sentences: #558 (comment). Each finding gives an acceptable sentence.

Definition of done

  • Each of the six sentences is replaced by a new short sentence that passes the sentence rules. Start from the acceptable text in the finding. Check every claim it makes against the code on next, and correct any part that is false; for example, check what the recovery routine does to a retrying delivery before writing "queues again".
  • Nothing else in the README changes, except a neighbouring sentence that has to change for the new one to read cleanly.
  • One PR into next, title ending (closes #N). It is reviewed by a fresh session on Fable that wrote none of the README. That review is also the documents check: it reads the whole README on the PR head, sentence by sentence.

Judgement call: the README was rewritten from scratch the day before under #558, and these are six separate sentences. So this unit fixes the six sentences and does not rewrite the whole document again. The fresh reading of the whole README is what guards against patching it into a worse state.

Model: opus-5-5

The documents check that comes before the next release-candidate tag failed `README.md` at `e584718` on six sentences: https://git.eeqj.de/sneak/webhooker/issues/558#issuecomment-155178. Each finding gives an acceptable sentence. **Definition of done** - Each of the six sentences is replaced by a new short sentence that passes the sentence rules. Start from the acceptable text in the finding. Check every claim it makes against the code on `next`, and correct any part that is false; for example, check what the recovery routine does to a `retrying` delivery before writing "queues again". - Nothing else in the README changes, except a neighbouring sentence that has to change for the new one to read cleanly. - One PR into `next`, title ending (closes #N). It is reviewed by a fresh session on Fable that wrote none of the README. That review is also the documents check: it reads the whole README on the PR head, sentence by sentence. Judgement call: the README was rewritten from scratch the day before under https://git.eeqj.de/sneak/webhooker/issues/558, and these are six separate sentences. So this unit fixes the six sentences and does not rewrite the whole document again. The fresh reading of the whole README is what guards against patching it into a worse state. Model: opus-5-5
clawbot self-assigned this 2026-10-26 06:13:53 +01:00
Author
Collaborator

The six sentences are fixed in #566. The PR body lists one correction made against the code: a retrying delivery is resumed, not queued again.

Model: opus-5-5

The six sentences are fixed in https://git.eeqj.de/sneak/webhooker/pulls/566. The PR body lists one correction made against the code: a `retrying` delivery is resumed, not queued again. Model: opus-5-5
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/webhooker#565