Refer to PatternMatcher API doc from makeInvitation #890
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
Adding a link to the newly generated do in @endojs, and a tiny bit of explanation.
Deploying with
|
| Latest commit: |
d772fa9
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://cb819f8f.documentation-7tp.pages.dev |
| Branch Preview URL: | https://chris-hibbert-patterns.documentation-7tp.pages.dev |
gibson042
approved these changes
Dec 6, 2023
dckc
reviewed
Dec 6, 2023
| @@ -102,6 +102,21 @@ The optional **customDetails** argument is included in the **Invitation**'s | |||
| The optional **proposalShape** argument can be used to describe the required and allowed components of each proposal. | |||
| Proposals that don't match the pattern will be rejected by Zoe without even being sent to the contract. | |||
|
|
|||
| Patterns are constructed using the | |||
| **[M](https://endojs.github.io/endo/interfaces/_endo_patterns.PatternMatchers.html)** (for '**M**atcher') object. | |||
There was a problem hiding this comment.
My impression is that these are not yet intended for wide dissemination. Building the docs was one step but publishing was another.
Oh... but now I find:
So we're committing to the endojs.github.io domain externally? Seems worth getting product / IT buy-in.
@turadg what's your sense of where we are with this?
There was a problem hiding this comment.
I agree it's worth getting cross-functional buy-in before linking to it from https://docs.agoric.com/
There was a problem hiding this comment.
@ivanlei , @sufyaankhan support this, for now; getting better integration with the docs site remains a goal.
For example, the search box on the docs site should find things from the endo TypeDoc.
turadg
approved these changes
Dec 6, 2023
Co-authored-by: Richard Gibson <[email protected]>
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.
Adding a link to the newly generated do in @endojs, and a tiny bit of explanation.