Miscellaneous godoc and comment improvements #485
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
These two functions are applying already committed logs to the FSM, so calling them apply is more consistent.
dnephin
commented
Jan 13, 2022
| @@ -72,7 +79,7 @@ func (r *Raft) runFSM() { | |||
| batchingFSM, batchingEnabled := r.fsm.(BatchingFSM) | |||
| configStore, configStoreEnabled := r.fsm.(ConfigurationStore) | |||
|
|
|||
| commitSingle := func(req *commitTuple) { | |||
| applySingle := func(req *commitTuple) { | |||
There was a problem hiding this comment.
I change this function name (and applyBatch below) because the operation it is performing is an Apply, not a commit.
Comment on lines
-239
to
+238
| err := BootstrapCluster(&cfg, r.logs, r.stable, r.snapshots, | ||
| r.trans, configuration) | ||
| err := BootstrapCluster(&cfg, r.logs, r.stable, r.snapshots, r.trans, configuration) |
There was a problem hiding this comment.
This awkward line wrapping isn't really necessary. Other lines in this file are at least this long, and many are much longer.
ncabatoff
approved these changes
Jan 24, 2022
| // current leader is being removed, it will cause a new election | ||
| // to occur. This must be run on the leader or it will fail. | ||
| // Use RemoveServer instead. | ||
| // RemovePeer from the cluster configuration. If the current leader is being |
There was a problem hiding this comment.
Missing a word in first sentence?
There was a problem hiding this comment.
I couldn't find many examples of this style, but I think they exist somewhere. Maybe I'll stumble on them again sometime. This style uses the method name as part of the sentence, so "remove peer from the cluster configuration".
Co-authored-by: Nick Cabatoff <ncabatoff@hashicorp.com>
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.
While reading the raft source code I found a number of places where the godoc or comments could be improved. I'm happy to revert or make further edits based on review feedback.
I also made a couple super minor code, which I will comment about inline.