docs: fix some comments errors #2391
Merged
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
Contributor
sysvm
commented
Jun 24, 2023
•
sysvm
commented
- fix some comments errors such as: misspelling, syntax error and so on.
- extract a string const.
sysvm
force-pushed
the
docs/fixcomments
branch
3 times, most recently
from
39571d2
to
38e0e92
Compare
p-shahi
reviewed
Jun 27, 2023
examples/multipro/node.go
Outdated
| // data: common p2p message data | ||
| func (n *Node) authenticateMessage(message proto.Message, data *p2p.MessageData) bool { | ||
| // store a temp ref to signature and remove it from message data | ||
| // sign is a string to allow easy reset to zero-value (empty string) | ||
| sign := data.Sign | ||
| data.Sign = nil | ||
|
|
||
| // marshall data without the signature to protobufs3 binary format | ||
| // marshall data without the signature to protobuf binary format |
There was a problem hiding this comment.
haven't looked but if it's actually marshaling to proto3 we may want to keep that distinction
p-shahi
reviewed
Jun 28, 2023
| @@ -31,7 +31,7 @@ func expectHeader(r *bufio.Reader, expected []byte) error { | |||
| return err | |||
| } | |||
| if !bytes.Equal(header, expected) { | |||
| return fmt.Errorf("expected file header %s, got: %s", pathPSKv1, header) | |||
| return fmt.Errorf("expected file header %s, got: %s", expected, header) | |||
There was a problem hiding this comment.
Makes sense to change this to expected but I am not the expert here, cc @marten-seemann
There was a problem hiding this comment.
Yes, this is correct, although in practice it doesn't make any difference, since this function is only called once with expected = pathPSKv1.
marten-seemann
approved these changes
Jun 28, 2023
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.