fix groupby documentation

materialsproject · Jan 18, 2024 · 9b8ad5c · 9b8ad5c
1 parent 91662da
commit 9b8ad5c
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/maggma/stores/open_data.py b/src/maggma/stores/open_data.py
@@ -275,7 +275,9 @@ def groupby(
 
         Args:
             keys: fields to group documents
-            criteria: PyMongo filter for documents to search in
+            criteria: the value of the `query` key will be used as the
+                Pandas string expression to query with;
+                all other data will be ignored
             properties: properties to return in grouped documents
             sort: Dictionary of sort order for fields. Keys are field names and
                 values are 1 for ascending or -1 for descending.