From 5c65c393a58e8914af4c6f13b74cd48f6266c4d4 Mon Sep 17 00:00:00 2001 From: Jonathan Boulle Date: Wed, 23 Dec 2015 16:37:06 +0100 Subject: [PATCH] raft: small typo fixes in raft package doc --- raft/doc.go | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/raft/doc.go b/raft/doc.go index 129c8973f..fa01f319d 100644 --- a/raft/doc.go +++ b/raft/doc.go @@ -15,12 +15,13 @@ /* Package raft provides an implementation of the raft consensus algorithm. -Raft is a protocol by which a cluster of nodes can maintain a replicated state machine. +Raft is a protocol with which a cluster of nodes can maintain a replicated state machine. The state machine is kept in sync through the use of a replicated log. -For more details on Raft, you can read In Search of an Understandable Consensus Algorithm +For more details on Raft, see "In Search of an Understandable Consensus Algorithm" (https://ramcloud.stanford.edu/raft.pdf) by Diego Ongaro and John Ousterhout. -A simple example application called, raftexample, is also avialable to help illustrate how to use this package in practice: +A simple example application, _raftexample_, is also available to help illustrate +how to use this package in practice: https://github.com/coreos/etcd/tree/master/contrib/raftexample Usage