chore: jsdoc improvements

Agoric · Jan 6, 2025 · f7b444c · f7b444c
1 parent f8f3b30
commit f7b444c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 9 deletions.
diff --git a/packages/zoe/src/zoeService/internal-types.js b/packages/zoe/src/zoeService/internal-types.js
@@ -114,12 +114,6 @@
  * @returns {Promise<BundleCap>}
  */
 
-/**
- * @callback GetProposalShapeForInvitation
- * @param {InvitationHandle} invitationHandle
- * @returns {Pattern | undefined}
- */
-
 /**
  * @typedef ZoeStorageManager
  * @property {MakeZoeInstanceStorageManager} makeZoeInstanceStorageManager
@@ -138,7 +132,7 @@
  * @property {GetInstallationForInstance} getInstallationForInstance
  * @property {GetInstanceAdmin} getInstanceAdmin
  * @property {UnwrapInstallation} unwrapInstallation
- * @property {GetProposalShapeForInvitation} getProposalShapeForInvitation
+ * @property {(invitationHandle: InvitationHandle) => Pattern | undefined} getProposalShapeForInvitation
  */
 
 /**

diff --git a/packages/zoe/src/zoeService/types-ambient.js b/packages/zoe/src/zoeService/types-ambient.js
@@ -39,12 +39,14 @@
  * @property {GetInstance} getInstance
  * @property {GetInstallation} getInstallation
  * @property {GetInvitationDetails} getInvitationDetails
- * Return an object with the instance, installation, description, invitation
- * handle, and any custom properties specific to the contract.
+ *   Return an object with the instance, installation, description, invitation
+ *   handle, and any custom properties specific to the contract.
  * @property {GetFeeIssuer} getFeeIssuer
  * @property {GetConfiguration} getConfiguration
  * @property {GetBundleIDFromInstallation} getBundleIDFromInstallation
  * @property {(invitationHandle: InvitationHandle) => Pattern | undefined} getProposalShapeForInvitation
+ *   Return the pattern (if any) associated with the invitationHandle that a
+ *   proposal is required to match to be accepted by zoe.offer().
  */
 
 /**