chore: documentation

Tanax · Oct 27, 2019 · 14088b6 · 14088b6
1 parent bb93026
commit 14088b6
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/datastore.go b/datastore.go
@@ -6,6 +6,10 @@ import (
 
 // Datastore represents how our data store should look
 type Datastore interface {
+	// Get retrieves a propagated storage model that contains the propagated item. Populates
+	// the model passed in by pointer to this method and returns an error if something goes wrong.
 	Get(ctx context.Context, model *Model) error
+	// Save stores a propagated storage model that contains the propagated item in the datastore. Returns
+	// an error if it fails.
 	Save(ctx context.Context, model *Model) error
 }