update interface doc

sourcenetwork · Mar 6, 2024 · 27f020a · 27f020a
1 parent f60e4ac
commit 27f020a
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/client/db.go b/client/db.go
@@ -191,6 +191,9 @@ type Store interface {
 
 	// GetCollections returns all collections and their descriptions matching the given options
 	// that currently exist within this [Store].
+	//
+	// Inactive collections are not returned by default unless a specific schema version ID
+	// is provided.
 	GetCollections(context.Context, CollectionFetchOptions) ([]Collection, error)
 
 	// GetSchemaByVersionID returns the schema description for the schema version of the

diff --git a/db/collection.go b/db/collection.go
@@ -709,8 +709,11 @@ func (db *db) getCollectionByName(ctx context.Context, txn datastore.Txn, name s
 	return cols[0], nil
 }
 
-// GetCollections returns all collections and their descriptions matching the given options
+// getCollections returns all collections and their descriptions matching the given options
 // that currently exist within this [Store].
+//
+// Inactive collections are not returned by default unless a specific schema version ID
+// is provided.
 func (db *db) getCollections(
 	ctx context.Context,
 	txn datastore.Txn,