docs: consolidate proposal shapes #1012
Merged
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
dckc
changed the title
|
@kriskowal thanks for moving Agoric/agoric-sdk#8536 along, but I suspect the ci failure here is due to a regression from that change. Clues? cc @michaelfig |
gibson042
approved these changes
Mar 20, 2024
Comment on lines
108
to
113
| The optional **proposalShape** argument can be used to describe the required and allowed components of each proposal. | ||
|
|
||
| ### Proposal Shapes | ||
|
|
||
| Proposals that don't match the pattern will be rejected by Zoe without even being sent to the contract. | ||
|
|
There was a problem hiding this comment.
Suggested change
| The optional **proposalShape** argument can be used to describe the required and allowed components of each proposal. | |
| ### Proposal Shapes | |
| Proposals that don't match the pattern will be rejected by Zoe without even being sent to the contract. | |
| The optional **proposalShape** argument can be used to describe the required and allowed components of each proposal. | |
| Proposals that don't match the provided pattern will be rejected by Zoe without even being sent to the contract. | |
| ### Proposal Shapes | |
There was a problem hiding this comment.
I think it was like that before; doesn't that mean people have to read before the heading to get the main point?
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.
fixes #951
closes #739
closes #880
Turns out Proposal Shape was documented already, under
E(zoe).offer(...). And the endo reference docs cover Pattern Matchers pretty well.It was also mentioned under zcf.makeInvitation. Since this is the more directly relevant API, I moved the material here and cross-referenced it.
And I copied the
Matchersinterface that gives all the methods ofM.My editor does markdown lint on save; I hope it's not too distracting that I mixed in work on #945 here. I did put it in separate commits.