docs: update parameter type for getProposalShapeForInvitation() #1258
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deploying documentation with
|
| Latest commit: |
5218b61
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://68fcd1a2.documentation-7tp.pages.dev |
| Branch Preview URL: | https://8606-proposalshape.documentation-7tp.pages.dev |
|
Cloudflare deployment logs are available here |
Chris-Hibbert
added a commit
to Agoric/agoric-sdk
that referenced
this pull request
Dec 17, 2024
correct one typeGuard Also noticed that the types documented for getProposalShapeForInvitation were incorrect. fixed that with Agoric/documentation#1258
dckc
approved these changes
Dec 17, 2024
| @@ -197,9 +197,9 @@ these methods: | |||
| const instance = await E(Zoe).getInstance(invitation); | |||
| ``` | |||
|
|
|||
| ## E(Zoe).getProposalShapeForInvitation(invitation) | |||
| ## E(Zoe).getProposalShapeForInvitation(invitationHandle) | |||
There was a problem hiding this comment.
yes, this matches generated reference docs
There was a problem hiding this comment.
p.s. here's hoping for the day when we don't have to maintain these docs in 2 places
Chris-Hibbert
added a commit
to Agoric/agoric-sdk
that referenced
this pull request
Jan 6, 2025
correct one typeGuard Also noticed that the types documented for getProposalShapeForInvitation were incorrect. fixed that with Agoric/documentation#1258
Chris-Hibbert
added a commit
to Agoric/agoric-sdk
that referenced
this pull request
Jan 7, 2025
correct one typeGuard improve jsdoc Also noticed that the types documented for getProposalShapeForInvitation were incorrect. fixed that with Agoric/documentation#1258
Chris-Hibbert
added a commit
to Agoric/agoric-sdk
that referenced
this pull request
Jan 7, 2025
correct one typeGuard improve jsdoc Also noticed that the types documented for getProposalShapeForInvitation were incorrect. fixed that with Agoric/documentation#1258
mergify bot
added a commit
to Agoric/agoric-sdk
that referenced
this pull request
Jan 7, 2025
closes: #8606 closes: #8597 ## Description #8597 suggested adding a test proposal guards in Zoe. This adds that test, and also cleans up a redundant check in coveredCall. The added test exposed a mistake in the Zoe doc, so [1258](Agoric/documentation#1258) fixes that as well. ### Security Considerations None ### Scaling Considerations None. ### Documentation Considerations Improved documentation. ### Testing Considerations Added tests. ### Upgrade Considerations These changes do not impact code on-chain. There's a correction to an example contract, an improvement in a TypeGuard, and a documentation update which will be separately release.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I included a test for
getProposalShapeForInvitation()in a more general test for invitation guards, and discovered that the docs were incorrect. This corrects them.