Merge pull request #56 from JorikSchellekens/patch-1

Fix documentation missmatch for crypto methods.
libp2p · Dec 7, 2019 · 54a9d30 · 54a9d30
2 parents 2ab3ece + dd55087
commit 54a9d30
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/crypto/key.go b/crypto/key.go
@@ -351,12 +351,12 @@ func MarshalPrivateKey(k PrivKey) ([]byte, error) {
 	return proto.Marshal(pbmes)
 }
 
-// ConfigDecodeKey decodes from b64 (for config file), and unmarshals.
+// ConfigDecodeKey decodes from b64 (for config file) to a byte array that can be unmarshalled.
 func ConfigDecodeKey(b string) ([]byte, error) {
 	return base64.StdEncoding.DecodeString(b)
 }
 
-// ConfigEncodeKey encodes to b64 (for config file), and marshals.
+// ConfigEncodeKey encodes a marshalled key to b64 (for config file).
 func ConfigEncodeKey(b []byte) string {
 	return base64.StdEncoding.EncodeToString(b)
 }