raft: fix godoc about starting a node

This commit is contained in:
funkygao 2015-03-17 10:00:08 +08:00 committed by Yicheng Qin
parent 02fb648abf
commit 9ea80c6ac1

View File

@ -18,7 +18,7 @@ Package raft provides an implementation of the raft consensus algorithm.
The primary object in raft is a Node. You either start a Node from scratch
using raft.StartNode or start a Node from some initial state using raft.RestartNode.
storage := raft.NewMemoryStorage()
n := raft.StartNode(0x01, []int64{0x02, 0x03}, 3, 1, storage)
n := raft.StartNode(0x01, []raft.Peer{{ID: 0x02}, {ID: 0x03}}, 3, 1, storage)
Now that you are holding onto a Node you have a few responsibilities: