add docstrings

internal/data/IDatastore.go

@@ -1,6 +1,7 @@
 package data
 
-// TODO docstring
+// Defines the first layer of abstraction on the interface to a persistent data
+// store. This may be a file or database.
 type IDatastore interface {
     Set(key string, val string) error
     KeyExists(key string)       (bool, error)

internal/data/IIdentifiable.go

@@ -1,6 +1,7 @@
 package data
 
-// TODO docstring
+// Defines an Id function that uniquely identifies an object. This may be used
+// as a primary key in a database/ datastore. 
 type IIdentifiable interface {
     Id() string // not allowed to contain a ':'
 }

internal/data/ISearchCriteria.go

@@ -1,6 +1,7 @@
 package data
 
-// TODO docstring
+// Defines a Weight function that determines a order on type T. As an example
+// this may be used to sort article by date or filter for a search term. 
 type ISortCriteria[T any] interface {
     Weight(t T) int
 }