spelling

Author: wantonsolutions

example/ClientServer/ClientServer.go

@@ -2,12 +2,14 @@ package main
 
 import (
 	"fmt"
-	"github.com/DistributedClocks/GoVector/govec"
 	"net"
 	"os"
 	"time"
+
+	"github.com/DistributedClocks/GoVector/govec"
 )
 
+//Hardcoded client/sever port values, and total messages sent
 const (
 	SERVERPORT = "8080"
 	CLIENTPORT = "8081"

example/MessagePack/MessagePackTests.go

@@ -7,6 +7,8 @@ import (
 	"github.com/vmihailenco/msgpack"
 )
 
+//ClockPayload is the wire type for vector clocks, and their
+//associated payloads
 type ClockPayload struct {
 	Pid     string
 	VcMap   map[string]uint64

govec/govec.go

@@ -22,7 +22,7 @@ var (
 	_             msgpack.CustomDecoder = (*VClockPayload)(nil)
 )
 
-//LogPriority controls the minumum priority of logging events which
+//LogPriority controls the minimum priority of logging events which
 //will be logged.
 type LogPriority int
 
@@ -58,7 +58,7 @@ var prefixLookup = [...]string{
 //input to GoLog initialization. See defaults in GetDefaultsConfig
 type GoLogConfig struct {
 	//If true logging events are buffered until flushed. This option
-	//increase logging performance at the cost of saftey.
+	//increase logging performance at the cost of safety.
 	Buffered bool
 	//Logging events are printed to screen
 	PrintOnScreen bool
@@ -273,7 +273,7 @@ func InitGoVector(processid string, logfilename string, config GoLogConfig) *GoL
 	}
 	print(config.EncodingStrategy)
 
-	//we create a new Vector Clock with processname and 0 as the intial time
+	//we create a new Vector Clock with processname and 0 as the initial time
 	vc1 := vclock.New()
 	vc1.Tick(processid)
 	gv.currentVC = vc1

govec/vclock/vclock.go

@@ -11,13 +11,17 @@ import (
 // and may be ORed together when being provided to the Compare method.
 type Condition int
 
+//Constants define compairison conditions between pairs of vector
+//clocks
 const (
 	Equal Condition = 1 << iota
 	Ancestor
 	Descendant
 	Concurrent
 )
 
+//Vector clocks are maps of string to uint64 where the string is the
+//id of the process, and the uint64 is the clock value
 type VClock map[string]uint64
 
 //FindTicks returns the clock value for a given id, if a value is not
@@ -130,7 +134,7 @@ func (vc VClock) ReturnVCString() string {
 }
 
 //Compare takes another clock and determines if it is Equal, an
-//Ancestor, Decendent, or Concurrent with the callees clock.
+//Ancestor, Descendant, or Concurrent with the callees clock.
 func (vc VClock) Compare(other VClock, cond Condition) bool {
 	var otherIs Condition
 	// Preliminary qualification based on length

govec/vrpc/vrpc.go

@@ -24,7 +24,7 @@ func RPCDial(network, address string, logger *govec.GoLog) (*rpc.Client, error)
 	return rpc.NewClientWithCodec(newClientCodec(conn, logger)), err
 }
 
-//ServeRPCCon is a convenience function that accepts connections for a
+//ServerRPCCon is a convenience function that accepts connections for a
 //given listener and starts a new goroutine for the server to serve a
 //new connection. The logger is provided to be used by the
 //RPCServerCodec for message capture.