Merge pull request #134 from MichaelMure/review

document and clean small things

handlers.go

@@ -355,8 +355,8 @@ func (dht *IpfsDHT) handleAddProvider(ctx context.Context, p peer.ID, pmes *pb.M
 	pinfos := pb.PBPeersToPeerInfos(pmes.GetProviderPeers())
 	for _, pi := range pinfos {
 		if pi.ID != p {
-			// we should ignore this provider reccord! not from originator.
-			// (we chould sign them and check signature later...)
+			// we should ignore this provider record! not from originator.
+			// (we should sign them and check signature later...)
 			log.Debugf("handleAddProvider received provider %s from %s. Ignore.", pi.ID, p)
 			continue
 		}
@@ -367,7 +367,7 @@ func (dht *IpfsDHT) handleAddProvider(ctx context.Context, p peer.ID, pmes *pb.M
 		}
 
 		log.Infof("received provider %s for %s (addrs: %s)", p, c, pi.Addrs)
-		if pi.ID != dht.self { // dont add own addrs.
+		if pi.ID != dht.self { // don't add own addrs.
 			// add the received addresses to our peerstore.
 			dht.peerstore.AddAddrs(pi.ID, pi.Addrs, pstore.ProviderAddrTTL)
 		}

notif.go

@@ -37,7 +37,7 @@ func (nn *netNotifiee) Connected(n inet.Network, v inet.Conn) {
 		return
 	}
 
-	// Note: Unfortunately, the peerstore may not yet now that this peer is
+	// Note: Unfortunately, the peerstore may not yet know that this peer is
 	// a DHT server. So, if it didn't return a positive response above, test
 	// manually.
 	go nn.testConnection(v)

query.go

+// package query implement a query manager to drive concurrent workers
+// to query the DHT. A query is setup with a target key, a queryFunc tasked
+// to communicate with a peer, and a set of initial peers. As the query
+// progress, queryFunc can return closer peers that will be used to navigate
+// closer to the target key in the DHT until an answer is reached.
 package dht
 
 import (
@@ -224,7 +229,7 @@ func (r *dhtQueryRunner) queryPeer(proc process.Process, p peer.ID) {
 
 	// make sure we do this when we exit
 	defer func() {
-		// signal we're done proccessing peer p
+		// signal we're done processing peer p
 		r.peersRemaining.Decrement(1)
 		r.rateLimit <- struct{}{}
 	}()
@@ -283,7 +288,7 @@ func (r *dhtQueryRunner) queryPeer(proc process.Process, p peer.ID) {
 	} else if len(res.closerPeers) > 0 {
 		log.Debugf("PEERS CLOSER -- worker for: %v (%d closer peers)", p, len(res.closerPeers))
 		for _, next := range res.closerPeers {
-			if next.ID == r.query.dht.self { // dont add self.
+			if next.ID == r.query.dht.self { // don't add self.
 				log.Debugf("PEERS CLOSER -- worker for: %v found self", p)
 				continue
 			}

routing.go

@@ -157,10 +157,10 @@ func (dht *IpfsDHT) GetValues(ctx context.Context, key string, nvals int) (_ []r
 	vals := make([]routing.RecvdVal, 0, nvals)
 	var valslock sync.Mutex
 
-	// If we have it local, dont bother doing an RPC!
+	// If we have it local, don't bother doing an RPC!
 	lrec, err := dht.getLocal(key)
 	if err == nil {
-		// TODO: this is tricky, we dont always want to trust our own value
+		// TODO: this is tricky, we don't always want to trust our own value
 		// what if the authoritative source updated it?
 		log.Debug("have it locally")
 		vals = append(vals, routing.RecvdVal{
@@ -219,7 +219,7 @@ func (dht *IpfsDHT) GetValues(ctx context.Context, key string, nvals int) (_ []r
 			valslock.Lock()
 			vals = append(vals, rv)
 
-			// If weve collected enough records, we're done
+			// If we have collected enough records, we're done
 			if len(vals) >= nvals {
 				res.success = true
 			}
@@ -344,7 +344,7 @@ func (dht *IpfsDHT) findProvidersAsyncRoutine(ctx context.Context, key *cid.Cid,
 			}
 		}
 
-		// If we have enough peers locally, dont bother with remote RPC
+		// If we have enough peers locally, don't bother with remote RPC
 		// TODO: is this a DOS vector?
 		if ps.Size() >= count {
 			return