docs: improve Optimism module documentation #2455
Closed
Conversation
This file contains hidden or 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
CodSpeed Performance ReportMerging #2455 will not alter performanceComparing Summary
|
rakita
requested changes
Apr 29, 2025
Member
rakita
left a comment
rakita
left a comment
There was a problem hiding this comment.
These does not improve docs. They nees to be more on point
Updated and refined module-level doc comments across all major files related to OP Stack (Optimism) support in revm. The new comments clearly state the purpose, features, and scope of each module, highlighting their role in OP Stack integration. This improves code readability and helps new contributors and OP Stack integrators better understand the structure and functionality of the codebase.
mattsse
reviewed
May 24, 2025
Collaborator
mattsse
left a comment
mattsse
left a comment
There was a problem hiding this comment.
this also needlessly aliases u256 to storagevalue, this is just obfuscating things
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR improves the module-level documentation for Optimism-specific
components by replacing generic comments with more comprehensive descriptions.
Changes include:
Optimism's execution layer features
and storage handling
Fixes #1885