Typo fix Update commitment.go#12961
Merged
smartcontracts merged 1 commit intoethereum-optimism:developfrom Nov 19, 2024
Merged
Conversation
Fix typo in comment for Keccak256Commitment.Encode method
Contributor
|
/ci authorize 92ef94a |
smartcontracts
approved these changes
Nov 19, 2024
Contributor
|
Thanks! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Description
This pull request corrects a typo in the comment for the
Encodemethod of theKeccak256Commitmenttype.Issue:
The original comment contained an incorrect word:
// Encode adds a commitment type prefix self describing the commitment.The word "self" is not appropriate in this context and should be replaced with "that" to make the sentence grammatically correct and clear.
Fix:
The corrected comment is:
// Encode adds a commitment type prefix that describes the commitment.Importance:
Accurate and clear comments are essential for maintaining code readability and understanding. This fix ensures that future developers reading the code will not be confused by the incorrect use of "self" in the comment.
Changes:
Encodemethod in theKeccak256Commitmenttype.Let me know if there are additional areas to improve!