Update documentation about dispatch lists#433
Merged
urikirsh merged 6 commits intorelease/version_8.3.0from Sep 26, 2025
Merged
Update documentation about dispatch lists#433urikirsh merged 6 commits intorelease/version_8.3.0from
urikirsh merged 6 commits intorelease/version_8.3.0from
Conversation
Update the grammar quite a bit (it was very outdated, still only had the deprecated syntax...), and add a section about dispatch list in the summaries.
johspaeth
reviewed
Aug 22, 2025
Contributor
johspaeth
left a comment
There was a problem hiding this comment.
Thanks! looks good, just a few comments.
docs/cvl/methods.md
Outdated
| This will dispatch unresolved calls of a method `foo` to implementations in contracts | ||
| `C` and `D`. | ||
|
|
||
| A `DISPATCH` summary is only useful on unresolved calls, so no policy should be specified. |
Contributor
There was a problem hiding this comment.
I am not sure I understand, what do you mean by this?
Contributor
Author
There was a problem hiding this comment.
That you shouldn't put "ALL" or "DELETE" or something like that at the end. I copied the wording from the catch-unresolved-calls section where it says "Also, the visibility is always external, and no policy should be specified."
Contributor
Author
There was a problem hiding this comment.
I'm adding "application" since we call it an application policy earlier.
docs/cvl/methods.md
Outdated
| restrict which contract's implementations of the method to consider: | ||
| ```cvl | ||
| methods { | ||
| function _.foo() external => DISPATCH(true)[ C._, D._ ]; |
Contributor
There was a problem hiding this comment.
Suggested change
| function _.foo() external => DISPATCH(true)[ C._, D._ ]; | |
| function _.foo() external => DISPATCH(true)[ C.foo, D._ ]; |
...and then briefly explain that foo is implicit, so that we have both cases here.
Co-authored-by: Johannes Späth <johspaeth@users.noreply.github.com>
johspaeth
approved these changes
Aug 22, 2025
urikirsh
added a commit
that referenced
this pull request
Oct 5, 2025
* Update documentation about dispatch lists (#433) * Update methods.md Update the grammar quite a bit (it was very outdated, still only had the deprecated syntax...), and add a section about dispatch list in the summaries. * fix typo * Some whitespace changes for prettification * Update docs/cvl/methods.md Co-authored-by: Johannes Späth <johspaeth@users.noreply.github.com> * Some improvements based on CR --------- Co-authored-by: Johannes Späth <johspaeth@users.noreply.github.com> Co-authored-by: urikirsh <uri@certora.com> * changelog v1 of v8.3.0 (#443) * changelog v1 of v8.3.0 * added imprecisions to wording list * title sizes were too big * Update methods.md --------- Co-authored-by: christiane-certora <christiane@certora.com> Co-authored-by: Johannes Späth <johspaeth@users.noreply.github.com>
This file contains hidden or 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
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.
Update the grammar quite a bit (it was very outdated, still only had the deprecated syntax...), and add a section about dispatch list in the summaries.
Naming convention:
Before requesting review:
spelling_wordlist.txtREADME.mdfor information about style and markdown syntaxJira ticket: TODO
Link to generated documentation: https://certora-certora-prover-documentation--433.com.readthedocs.build/en/433/docs/cvl/methods.html