Skip to content

Commit a6d91b2

Browse files
committed
docs(plugin-approvals): recall's docblock summary line states the status, not an exclusive actor set
The block opened "Withdraw a pending request (submitter only)" and its third paragraph stated the #3424 privileged override reaching a PENDING request. Both cannot be true; `overrideAdmits` settles it in the paragraph's favour by short-circuiting the non-submitter guard on a pending row. The summary line is what an editor hover and any single-line extraction show, so it is the half that gets read alone. The line now reads "Withdraw an undecided request." — status is the axis and the actor rules stay with the paragraphs that already state them correctly, the same structural move the `IApprovalService.recall` docstring makes on the spec side. Comment-only: no guard, branch or signature changed. It ships in the published `dist/index.d.ts`, so it takes a patch changeset rather than `skip-changeset`. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XpTx2tbq3pZRYAdoGt6E6Y
1 parent 3e270d4 commit a6d91b2

2 files changed

Lines changed: 12 additions & 1 deletion

File tree

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
"@objectstack/plugin-approvals": patch
3+
---
4+
5+
Documentation: `ApprovalService.recall`'s docblock summary line no longer claims the submitter is the only actor.
6+
7+
The block opened with "Withdraw a pending request (submitter only)" and then, three paragraphs down, stated the #3424 privileged override correctly — "The #3424 privileged override reaches a PENDING request only (#12775, maintainer ruling 2026-09-02)". Both cannot be true, and the code settles it in the paragraph's favour: `overrideAdmits` short-circuits the non-submitter guard on a `pending` request. A reader who finishes the block is not misled, but the summary line is the one an editor shows on hover and the one any single-line extraction takes.
8+
9+
The summary line now reads "Withdraw an undecided request." — status is the axis and the actor rules are left to the paragraphs that already state them correctly, the same structural move the `IApprovalService.recall` docstring makes on the spec side.
10+
11+
Prose only: no guard, no branch and no signature changed. It earns a changeset rather than `skip-changeset` because `@objectstack/plugin-approvals` publishes `dist/`, and this text ships inside the published `dist/index.d.ts` for `ApprovalService.recall`.

packages/plugins/plugin-approvals/src/approval-service.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3146,7 +3146,7 @@ export class ApprovalService implements IApprovalService {
31463146
}
31473147

31483148
/**
3149-
* Withdraw a pending request (submitter only). Finalises the row as
3149+
* Withdraw an undecided request. Finalises the row as
31503150
* `recalled`, releases the record lock (keyed on pending status), mirrors
31513151
* the status field when configured, and resumes the owning flow run down
31523152
* the `reject` branch with `output.decision = 'recall'` — leaving the run

0 commit comments

Comments
 (0)