Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CERT-6637: Add entry about receiveOrFallback in glossary #284

Merged
merged 5 commits into from
Sep 2, 2024

Conversation

christiane-certora
Copy link
Contributor

@christiane-certora christiane-certora commented Jul 26, 2024

Based on changes in https://github.com/Certora/EVMVerifier/pull/6226 for the display of that.

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--284.com.readthedocs.build/en/284/docs/user-guide/glossary.html#term-receiveOrFallback

@christiane-certora christiane-certora changed the title Add entry about receiveOrFallback in glossary CERT-6637: Add entry about receiveOrFallback in glossary Jul 29, 2024
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.

Just a minor point. I think we should add a link. Thanks.

Comment on lines +185 to +186
A special function we introduce in every contract to model the behavior of solidity
for calls with no data or that do not resolve to any contract function.
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 should we add a link to the official EVM docs here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

Exactly 👍

@johspaeth johspaeth added the release documentation for an upcoming release label Jul 30, 2024
@johspaeth
Copy link
Contributor

Thanks for preparing - I added the label release. Uri or me will merge this with the next release then such that docs align with the current version.

@urikirsh urikirsh merged commit c4a19dd into master Sep 2, 2024
2 checks passed
@urikirsh urikirsh deleted the christiane/rename-certorafallback_0-display-only branch September 2, 2024 07:38
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