add docstring for CollectionResoureceIDWithDatabase

google · Nov 22, 2023 · ff1f875 · ff1f875
1 parent e5c545d
commit ff1f875
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docstore/gcpfirestore/fs.go b/docstore/gcpfirestore/fs.go
@@ -149,6 +149,8 @@ func CollectionResourceID(projectID, collPath string) string {
 	return fmt.Sprintf("projects/%s/databases/(default)/documents/%s", projectID, collPath)
 }
 
+// CollectResoureceIDWithDatabase constructs a resource ID for a collection from the project ID, database ID, and the collection path.
+// See the OpenCollection example for use.
 func CollectionResourceIDWithDatabase(projectID, databaseID, collPath string) string {
 	return fmt.Sprintf("projects/%s/databases/%s/documents/%s", projectID, databaseID, collPath)
 }