Improve comments on message Ops #3987
Merged
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves inline documentation for message operation categorization and removes unused variable arrays. The key changes include updating the comment for adding new parseable Ops and removing several unused collections (e.g. HandshakeOps, ConsensusRequestOps).
Comments suppressed due to low confidence (2)
message/ops.go:18
- Consider expanding this comment to briefly explain the criteria for choosing between 'UnrequestedOps' and 'FailedToResponseOps' to aid future maintainers.
// Note: If you add a new parseable Op below, you must add it to either UnrequestedOps or FailedToResponseOps.
message/ops.go:68
- Add a short note clarifying the purpose of using set.Of for the UnrequestedOps grouping and confirm that this approach aligns with project conventions for handling collections.
UnrequestedOps = set.Of(
StephenButtolph
requested review from
a team and
DracoLi
and removed request for
a team
DracoLi
approved these changes
Jun 2, 2025
maru-ava
approved these changes
Jun 3, 2025
samliok
pushed a commit
that referenced
this pull request
Jun 3, 2025
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.
Why this should be merged
How this works
These variables are unused 🧹.
How this was tested
CI
Need to be documented in RELEASES.md?