From 4554c160183a4692028509e0a085c4a678095f03 Mon Sep 17 00:00:00 2001
From: Hector Sanjuan <code@hector.link>
Date: Thu, 5 Mar 2020 14:37:03 +0100
Subject: [PATCH] keystore: resolve linting problems. Improve godocs.

---
 keystore/keystore.go      | 11 ++++++++---
 keystore/keystore_test.go |  4 ++--
 keystore/memkeystore.go   |  1 +
 3 files changed, 11 insertions(+), 5 deletions(-)

diff --git a/keystore/keystore.go b/keystore/keystore.go
index 37841be94c9..5313bc105e4 100644
--- a/keystore/keystore.go
+++ b/keystore/keystore.go
@@ -30,7 +30,10 @@ type Keystore interface {
 	List() ([]string, error)
 }
 
+// ErrNoSuchKey is an error message returned when no key of a given name was found.
 var ErrNoSuchKey = fmt.Errorf("no key by the given name was found")
+
+// ErrKeyExists is an error message returned when a key already exists
 var ErrKeyExists = fmt.Errorf("key by that name already exists, refusing to overwrite")
 
 // FSKeystore is a keystore backed by files in a given directory stored on disk.
@@ -54,12 +57,13 @@ func validateName(name string) error {
 	return nil
 }
 
-// NewKeystore is a factory for getting instance of Keystore interface implementation
+// NewKeystore returns a Keystore using the default implementation.
 func NewKeystore(dir string) (Keystore, error) {
 	return NewEncodedFSKeystore(dir)
 }
 
-// NewEncodedFSKeystore is a factory for getting instance of EncodedFSKeystore
+// NewEncodedFSKeystore is returns a filesystem-backed keystore which encodes
+// key names using base32.
 func NewEncodedFSKeystore(dir string) (*EncodedFSKeystore, error) {
 	keystore, err := NewFSKeystore(dir)
 
@@ -70,6 +74,7 @@ func NewEncodedFSKeystore(dir string) (*EncodedFSKeystore, error) {
 	return &EncodedFSKeystore{keystore}, nil
 }
 
+// NewFSKeystore returns a new filesystem-backed keystore.
 func NewFSKeystore(dir string) (*FSKeystore, error) {
 	_, err := os.Stat(dir)
 	if err != nil {
@@ -291,7 +296,7 @@ func (ks *EncodedFSKeystore) List() ([]string, error) {
 		if err == nil {
 			list = append(list, decodedName)
 		} else {
-			log.Warningf("Ignoring keyfile with invalid encoded filename: %s", name)
+			log.Warnf("Ignoring keyfile with invalid encoded filename: %s", name)
 		}
 	}
 
diff --git a/keystore/keystore_test.go b/keystore/keystore_test.go
index 685e5d942ef..fc9a8faafe3 100644
--- a/keystore/keystore_test.go
+++ b/keystore/keystore_test.go
@@ -231,12 +231,12 @@ func TestMakeKeystoreNoDir(t *testing.T) {
 }
 
 func assertGetKey(ks Keystore, name string, exp ci.PrivKey) error {
-	out_k, err := ks.Get(name)
+	outK, err := ks.Get(name)
 	if err != nil {
 		return err
 	}
 
-	if !out_k.Equals(exp) {
+	if !outK.Equals(exp) {
 		return fmt.Errorf("key we got out didnt match expectation")
 	}
 
diff --git a/keystore/memkeystore.go b/keystore/memkeystore.go
index 4067bbce29a..d5780a8aa0c 100644
--- a/keystore/memkeystore.go
+++ b/keystore/memkeystore.go
@@ -8,6 +8,7 @@ type MemKeystore struct {
 	keys map[string]ci.PrivKey
 }
 
+// NewMemKeystore creates a MemKeystore.
 func NewMemKeystore() *MemKeystore {
 	return &MemKeystore{make(map[string]ci.PrivKey)}
 }