Improve modref docs #1256
Merged
Improve modref docs #1256
Conversation
This file contains 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
rsoeldner
reviewed
Jul 23, 2023
jwiegley
reviewed
Jul 24, 2023
|
@rsoeldner @jwiegley I rewrote a lot of the sections with code examples and removed the TODOs. I do mention pinned modrefs as a possible future feature, and expanded the vuln description. Do you mind re-reviewing now? |
rsoeldner
approved these changes
Jul 31, 2023
|
Are the rst files automatically generated or hand curated? It looks like the last commits special modifications. |
Automatically (manually triggered) -- |
EnoF
reviewed
Aug 1, 2023
EnoF
reviewed
Aug 1, 2023
EnoF
reviewed
Aug 1, 2023
| and should not be confused with more object-oriented polymorphism like that found | ||
| with Java classes or Typescript types. Modules cannot "extend" one another, they | ||
| can only offer operations that match some interface specification, and interfaces | ||
| themselves cannot extend some other interface. |
There was a problem hiding this comment.
I think this is a much clearer paragraph now 👍
| directly call `pay-fee`. Thus a malicious actor can craft a version of `collect` | ||
| that can directly call `pay-fee` as many times as they like. | ||
| The problem with the above code is that the `with-capability` call happens | ||
| _before_ the calls to the modref operations, such that while the foreign module |
There was a problem hiding this comment.
I like the 'foreign module' terminology.
jwiegley
approved these changes
Aug 2, 2023
Co-authored-by: Thomas Honeyman <hello@thomashoneyman.com>
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.
Just docs, no downstream impacts or code coverage requirements.