-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
[aptos-framework] Add specs for account.move and coin.move #5237
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks like a good start, but the specifications are incomplete. State updates are not described. If we want to keep state changes unspecified for now, we should add a TODO. However, really the hard work here is to described the state updates ;-)
- add
modifies global<T>(addr)
clause for each modified state. - specify the post state of the modified slot
This should happen at least to all public functions (eventually).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your contribution to the Aptos Framework spec! My few general comments would be:
- if there are complex specs, please also add some comments (texts) to them for the readability sake
- please make sure the specs look fine in the generated document. The command to generate the document is:
$ aptos move document --include-impl --include-specs --collapsed-sections
$ cargo test -p framework
The documentation generator is run automatically! Don't run it manually please, because it won't have the right options. Documentation is automatically updated if you run |
Just to ensure: Do I need to add the changes in the |
Yes, the source files and the generated doc need to be synced. So, If you update |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Loos good to me. Thank you again for the contribution!
It seems that there is a lint test failure in CI. It complains about trailing whitespaces. Could you fix it? |
Finished |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
✅ Forge suite
|
✅ Forge suite
|
Description
This is a part of spec work for Aptos Framework from MoveBit, we updated below files/modules in this PR:
Test Plan
This change is