address CR feedback

addr/addr.go

@@ -40,8 +40,8 @@ func init() {
 	SupportedTransportProtocols = transports
 }
 
-// FilterAddrs is a filter that removes certain addresses, according to filter.
-// if filter returns true, the address is kept.
+// FilterAddrs is a filter that removes certain addresses, according the given filters.
+// if all filters return true, the address is kept.
 func FilterAddrs(a []ma.Multiaddr, filters ...func(ma.Multiaddr) bool) []ma.Multiaddr {
 	b := make([]ma.Multiaddr, 0, len(a))
 	for _, addr := range a {

addr/filter.go

@@ -5,6 +5,7 @@ import (
 	mafmt "github.com/whyrusleeping/mafmt"
 )
 
+// SubtractFilter returns a filter func that filters all of the given addresses
 func SubtractFilter(addrs ...ma.Multiaddr) func(ma.Multiaddr) bool {
 	addrmap := make(map[string]bool)
 	for _, a := range addrs {
@@ -16,10 +17,13 @@ func SubtractFilter(addrs ...ma.Multiaddr) func(ma.Multiaddr) bool {
 	}
 }
 
+// IsFDCostlyTransport returns true for transports that require a new file
+// descriptor per connection created
 func IsFDCostlyTransport(a ma.Multiaddr) bool {
 	return mafmt.TCP.Matches(a)
 }
 
+// FilterNeg returns a negated version of the passed in filter
 func FilterNeg(f func(ma.Multiaddr) bool) func(ma.Multiaddr) bool {
 	return func(a ma.Multiaddr) bool {
 		return !f(a)

swarm_dial.go

@@ -390,9 +390,6 @@ func (s *Swarm) dialAddrs(ctx context.Context, p peer.ID, remoteAddrs <-chan ma.
 				continue
 			}
 
-			// limitedDial will start a dial to the given peer when
-			// it is able, respecting the various different types of rate
-			// limiting that occur without using extra goroutines per addr
 			s.limitedDial(ctx, p, addr, respch)
 			active++
 		case <-ctx.Done():
@@ -403,7 +400,7 @@ func (s *Swarm) dialAddrs(ctx context.Context, p peer.ID, remoteAddrs <-chan ma.
 		case resp := <-respch:
 			active--
 			if resp.Err != nil {
-				log.Error("got error on dial: ", resp.Err)
+				log.Info("got error on dial: ", resp.Err)
 				// Errors are normal, lots of dials will fail
 				exitErr = resp.Err
 
@@ -417,6 +414,9 @@ func (s *Swarm) dialAddrs(ctx context.Context, p peer.ID, remoteAddrs <-chan ma.
 	}
 }
 
+// limitedDial will start a dial to the given peer when
+// it is able, respecting the various different types of rate
+// limiting that occur without using extra goroutines per addr
 func (s *Swarm) limitedDial(ctx context.Context, p peer.ID, a ma.Multiaddr, resp chan dialResult) {
 	s.limiter.AddDialJob(&dialJob{
 		addr: a,