GroupBuilder: update doc

materialsproject · Oct 8, 2024 · c1ef139 · c1ef139
1 parent 003824b
commit c1ef139
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/docs/getting_started/group_builder.md b/docs/getting_started/group_builder.md
@@ -60,6 +60,7 @@ Note that unlike the previous `MapBuilder` example, we didn't call the source an
 
 `GroupBuilder` inherits from `MapBuilder` so it has the same configurational parameters.
 
+- query: A query to apply to items in the source Store.
 - projection: list of the fields you want to project. This can reduce the data transfer load if you only need certain fields or sub-documents from the source documents
 - timeout: optional timeout on the process function
 - store_process_timeout: adds the process time into the target document for profiling

diff --git a/src/maggma/builders/group_builder.py b/src/maggma/builders/group_builder.py
@@ -42,7 +42,7 @@ def __init__(
         Args:
             source: source store
             target: target store
-            query: optional query to filter source store
+            query: optional query to filter items from the source store.
             projection: list of keys to project from the source for
                 processing. Limits data transfer to improve efficiency.
             delete_orphans: Whether to delete documents on target store