Browse Source

raft: add doc for the Ready struct

Brandon Philips 11 years ago
parent
commit
145882244f
1 changed files with 2 additions and 0 deletions
  1. 2 0
      raft/node.go

+ 2 - 0
raft/node.go

@@ -11,6 +11,8 @@ import (
 
 
 var ErrStopped = errors.New("raft: stopped")
 var ErrStopped = errors.New("raft: stopped")
 
 
+// Ready encapsulates the entries and messages that are ready to be saved to
+// stable storage, committed or sent to other peers.
 type Ready struct {
 type Ready struct {
 	// The current state of a Node
 	// The current state of a Node
 	pb.State
 	pb.State