[core] refs fibercrypto#142 - Document core interfaces

- KeyValueStorage - PasswordReader
simelo · Sep 30, 2019 · 965a7fc · 965a7fc
1 parent 9f24cb9
commit 965a7fc
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/src/core/storage.go b/src/core/storage.go
@@ -1,5 +1,6 @@
 package core
 
+// KeyValueStorage provides read / write access to values given a key
 type KeyValueStorage interface {
 	GetValue(key string) interface{}
 }
diff --git a/src/core/textutil.go b/src/core/textutil.go
@@ -1,3 +1,4 @@
 package core
 
+// PasswordReadeer secure retrieval of passwords from users
 type PasswordReader func(message string) (string, error)