docs: fix comment inconsistency in getParamsAndCheckValid method #2438
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
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request corrects a misleading comment for the getParamsAndCheckValid method. The new comment is a significant improvement in clarity. I have added one suggestion to make the comment even more descriptive by including the function's side effect of sending an error response upon validation failure.
Signed-off-by: bigmoonbit <[email protected]>
bigmoonbit
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Abstract
Corrected the misleading comment for the getParamsAndCheckValid method in websockets.go.
The comment previously incorrectly referred to this method as "tcpGetAndSendResponse", which is actually a different method in the same file.
The updated comment now accurately describes the function's purpose: extracting and validating parameters from incoming messages.