Make lint happy

pkg/partition/errors.go

@@ -19,8 +19,11 @@ func (e *errors) toError() error {
 	return (*e)[0]
 }
 
+// IncorrectPartitionError is a transient error that happens when
+// requests end up on the wrong partition.
 type IncorrectPartitionError struct{}
 
+// Error returns the error string
 func (e IncorrectPartitionError) Error() string {
 	return "incorrect partition, retry later"
 }

pkg/partition/hashring.go

@@ -13,6 +13,9 @@ import (
 	"sync"
 )
 
+// NewHashRing returns a picker which uses a consistent hashing scheme
+//
+// The scheme is implemented using a hash ring of crc32 hashes.
 func NewHashRing() func(ctx context.Context, list []string, hash uint64) string {
 	ring := &hashring{factor: 1000}
 	return ring.Pick

pkg/partition/internal/rpc/rpc.go

@@ -27,6 +27,7 @@ type RunCloser interface {
 	//io.Closer
 }
 
+// DialClient creates a RPC client
 func DialClient(ctx context.Context, addr string) (client, error) {
 	conn, err := grpc.DialContext(ctx, addr, grpc.WithInsecure())
 	if err != nil {
@@ -35,6 +36,7 @@ func DialClient(ctx context.Context, addr string) (client, error) {
 	return client{conn}, nil
 }
 
+// RegisterServer registers an RPC handler
 func RegisterServer(ctx context.Context, srv *grpc.Server, addr string, handler Runner) (io.Closer, error) {
 	var listener net.Listener
 	if srv == nil {

pkg/partition/partition.go

@@ -120,8 +120,7 @@ func WithEndpointRegistry(r EndpointRegistry) Option {
 	}
 }
 
-// Picker implements the algorithm to choose an endpoint given a hash
-// key.
+// WithPicker specifies how the pick endpoints based on the hash.
 //
 // The default algorithm is to use a consistent hash using a hash ring
 // (via NewHashRing()).