document metadata + metadata_updates in Flow class doc str

materialsproject · Nov 22, 2024 · b6786ca · b6786ca
1 parent 9f16d51
commit b6786ca
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/jobflow/core/flow.py b/src/jobflow/core/flow.py
@@ -67,6 +67,11 @@ class Flow(MSONable):
         automatically when a flow is included in the jobs array of another flow.
         The object identified by one UUID of the list should be contained in objects
         identified by its subsequent elements.
+    metadata
+        A dictionary of information that will get stored in the Flow collection.
+    metadata_updates
+        A list of updates for the metadata that will be applied to any dynamically
+        generated sub Flow/Job.
 
     Raises
     ------