From e0e0fd8e2ed378c1d2cdfe315ae0a4846cb299ed Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Thu, 30 Nov 2023 19:32:00 -0500 Subject: [PATCH] chore: Apply suggestions from code review Co-authored-by: Mark S. Miller --- main/guides/zoe/proposal.md | 4 ++-- main/reference/zoe-api/zcfmint.md | 2 +- main/reference/zoe-api/zoe.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/main/guides/zoe/proposal.md b/main/guides/zoe/proposal.md index f04b01b24c..539102d28e 100644 --- a/main/guides/zoe/proposal.md +++ b/main/guides/zoe/proposal.md @@ -13,7 +13,7 @@ To make an offer, you use [`E(zoe).offer(...)`](/reference/zoe-api/zoe.md#e-zoe- ## Invitations An [Invitation](/reference/zoe-api/zoe-data-types.md#invitation) is a special case of ERTP [Payment](/reference/ertp-api/payment.md). Each is linked to a specific contract [Instance](/reference/zoe-api/zoe-data-types.md#instance), and -having one gives you the right to participate in that contract instance by making offers in it. +having one gives you the right to participate in that contract instance by making offers with it. There are two main ways for contract users to get an invitation: - If you create the contract instance, the contract might supply a special creator invitation. @@ -52,7 +52,7 @@ In contrast, [Payments](/reference/ertp-api/payment.md) hold actual digital asse **exit** specifies how the offer can be cancelled. It must conform to one of three shapes: - `{ onDemand: null }`: (Default) The offering party can cancel on demand. -- `{ waived: null }`: The offering party can't cancel and relies entirely on the smart contract to promptly finish their offer. +- `{ waived: null }`: The offering party can't cancel and relies entirely on the smart contract to complete (finish or fail) their offer. - `{ afterDeadline: deadlineDetails }`: The offer is automatically cancelled after a deadline, as determined by its `timer` and `deadline` properties. diff --git a/main/reference/zoe-api/zcfmint.md b/main/reference/zoe-api/zcfmint.md index ffc37bdc10..133bec9e8f 100644 --- a/main/reference/zoe-api/zcfmint.md +++ b/main/reference/zoe-api/zcfmint.md @@ -23,7 +23,7 @@ Mint the *gains* **Amount** of assets and add them to that **seat**'s **[Allocation](./zoe-data-types.md#allocation)**. If a **seat** is provided, it is returned. Otherwise a new **seat** is returned. -## aZCFMint.burnLosses(losses, zcfSeat?) +## aZCFMint.burnLosses(losses, zcfSeat) - **losses**: **[AmountKeywordRecord](./zoe-data-types.md#keywordrecord)** - **zcfSeat**: **[ZCFSeat](./zcfseat.md)** - Returns: None diff --git a/main/reference/zoe-api/zoe.md b/main/reference/zoe-api/zoe.md index a5c9d6c2ae..f32eb42561 100644 --- a/main/reference/zoe-api/zoe.md +++ b/main/reference/zoe-api/zoe.md @@ -320,7 +320,7 @@ the Keywords might be "Asset" and "Bid". **exit** specifies how the offer can be cancelled. It must conform to one of three shapes: - `{ onDemand: null }`: (Default) The offering party can cancel on demand. -- `{ waived: null }`: The offering party can't cancel and relies entirely on the smart contract to promptly finish their offer. +- `{ waived: null }`: The offering party can't cancel and relies entirely on the smart contract to complete (finish or fail) their offer. - `{ afterDeadline: deadlineDetails }`: The offer is automatically cancelled after a deadline, as determined by its **timer** and **deadline** properties. **timer** must be a timer, and **deadline** must be timestamp understood by it. @@ -343,7 +343,7 @@ const paymentKeywordRecord = harden({ ### Offer Arguments -**offerArgs** is an object that can be used to pass additional arguments to the +**offerArgs** is an optional CopyRecord that can be used to pass additional arguments to the **offerHandler** contract code associated with the invitation by [`zcf.makeInvitation(...)`](./zoe-contract-facet.md#zcf-makeinvitation-offerhandler-description-customproperties-proposalshape). Each contract can define the properties it supports and which are required.