Skip to content

Conversation

@christiane-certora
Copy link
Contributor

to document https://github.com/Certora/EVMVerifier/pull/8117

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: TODO

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

Tiny recomendation.

Comment on lines 240 to 243
If there is no method signature, the preserved block is a default block that is
used for all methods that don't have a specific preserved block, including the
`fallback()` method. If an invariant has both a default preserved block and a
`fallback()` method, but not the constructor.
If an invariant has both a default preserved block and a
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we can write this more explicit. Wdyt?

A method block with no method signature is called the generic preserved block. The generic preserved block is used for all methods that don't have a specific preserved block, including the fallback() method. Note, the generic preserved block is not applied for the induction base step, for the induction base step use preserved constructor instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Very nice. I also updated the whole section to call it "generic" and not sometimes "default", since that just seemed inconsistent and confusing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants