Skip to content

Update documentation about dispatch lists#433

Merged
urikirsh merged 6 commits intorelease/version_8.3.0from
christiane-dispatch-list-on-wildcards
Sep 26, 2025
Merged

Update documentation about dispatch lists#433
urikirsh merged 6 commits intorelease/version_8.3.0from
christiane-dispatch-list-on-wildcards

Conversation

@christiane-certora
Copy link
Copy Markdown
Contributor

@christiane-certora christiane-certora commented Aug 22, 2025

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:

  • PRs for features that are in design should have the "proposal" label
  • PRs for features that haven't landed yet should have the "future" label
  • PRs for upcoming releases should have the "release" label
  • PRs with new documentation for existing features should have the "existing feature" label

Before requesting review:

  • Make sure there is a ticket in the DOC board in Jira
  • Make sure CI is passing
    • Spell check failure may require adding backticks around code or updating spelling_wordlist.txt
    • See README.md for information about style and markdown syntax
    • If the CI Details link gives a 404, you need to log in to readthedocs.com
  • Add link to generated documentation here
    • you can find this by following the read the docs link from the CI check
  • Ask for help in #documentation

Jira ticket: TODO
Link to generated documentation: https://certora-certora-prover-documentation--433.com.readthedocs.build/en/433/docs/cvl/methods.html

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.
Copy link
Copy Markdown
Contributor

@johspaeth johspaeth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! looks good, just a few comments.

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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure I understand, what do you mean by this?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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."

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm adding "application" since we call it an application policy earlier.

restrict which contract's implementations of the method to consider:
```cvl
methods {
function _.foo() external => DISPATCH(true)[ C._, D._ ];
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

christiane-certora and others added 2 commits August 22, 2025 16:53
Co-authored-by: Johannes Späth <johspaeth@users.noreply.github.com>
@christiane-certora christiane-certora added the release documentation for an upcoming release label Aug 22, 2025
@urikirsh urikirsh changed the base branch from master to release/version_8.3.0 September 26, 2025 10:07
@urikirsh urikirsh merged commit 7f873c1 into release/version_8.3.0 Sep 26, 2025
2 checks passed
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release documentation for an upcoming release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants