Skip to content

Commit

Permalink
fixup! review suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
erights committed Feb 1, 2024
1 parent bd36e37 commit 20cc06a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
12 changes: 11 additions & 1 deletion packages/zoe/src/contractSupport/prepare-ownable.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,25 @@ const TransferProposalShape = M.splitRecord({
* @typedef {object} OwnableOptions
* @property {string} [uInterfaceName]
* The `interfaceName` of the underlying interface guard.
* Defaults to the uKindName
* Defaults to the `uKindName`.
*/

/**
* @template {any} [U=any]
* @param {import('@agoric/base-zone').Zone} zone
* @param {MakeInvitation} makeInvitation
* A function with the same behavior as `zcf.makeInvitation`.
* A contract will normally just extract it from its own zcf using the
* argument expression
* ```js
* (...args) => zcf.makeInvitation(...args)
* ```
* See ownable-counter.js for the canonical example.
* @param {string} uKindName
* The `kindName` of the underlying exo class
* @param {(string|symbol)[]} uMethodNames
* The method names of the underlying exo class that should be represented
* by transparently-forwarding methods of the wrapping ownable object.
* @param {OwnableOptions} [options]
* @returns {(underlying: U) => U}
*/
Expand Down
4 changes: 2 additions & 2 deletions packages/zoe/src/contractSupport/prepare-revocable.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const { Fail, quote: q } = assert;
* @typedef {object} RevocableKitOptions
* @property {string} [uInterfaceName]
* The `interfaceName` of the underlying interface guard.
* Defaults to the uKindName
* Defaults to the `uKindName`.
* @property {Record<
* string|symbol,
* import('@endo/patterns').MethodGuard
Expand All @@ -47,7 +47,7 @@ const { Fail, quote: q } = assert;
* The `kindName` of the underlying exo class
* @param {(string|symbol)[]} uMethodNames
* The method names of the underlying exo class that should be represented
* by a transparently-forwarding method of the revocable caretaker.
* by transparently-forwarding methods of the revocable caretaker.
* @param {RevocableKitOptions} [options]
* @returns {(underlying: U) => RevocableKit<U>}
*/
Expand Down

0 comments on commit 20cc06a

Please sign in to comment.