Skip to content

Commit ffef845

Browse files
committed
docs: prefer makeInvitation(..., proposalShape)
to assertProposalShape
1 parent 124663a commit ffef845

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

main/reference/zoe-api/zoe-helpers.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,10 @@ Checks the seat's proposal against the _proposalShape_ argument. If the proposal
226226
- **expected**: **ExpectedRecord**
227227
- Returns: None.
228228

229+
**Note: Most uses of `assertProposalShape` are better
230+
expressed using the `proposalShape` argument
231+
of [zcf.makeInvitation()](./zoe-contract-facet#zcf-makeinvitation-offerhandler-description-customdetails-proposalshape)**.
232+
229233
Checks the seat's proposal against an _expected_ record that says
230234
what shape of proposal is acceptable.
231235

0 commit comments

Comments
 (0)