Merge pull request #778 from KaplanOpenSource/issue641

docs(pydoc): Complete hermes workflow toolkit docstrings

Author: yehudarav

hera/simulations/LSM/hermesWorkflowToolkit.py

@@ -24,6 +24,12 @@
 
 @unique
 class actionModes(Enum):
+    """Workflow action modes controlling which steps are executed.
+
+    - ``ADD`` — add the workflow document to the database only.
+    - ``ADDBUILD`` — add and build (generate LSM input files).
+    - ``ADDBUILDEXECUTE`` — add, build, and execute the LSM simulation.
+    """
     ADD = auto()
     ADDBUILD = auto()
     ADDBUILDEXECUTE = auto()

hera/simulations/hermesWorkflowToolkit.py

@@ -25,6 +25,12 @@
 
 @unique
 class actionModes(Enum):
+    """Workflow action modes controlling which steps are executed.
+
+    - ``ADD`` — add the workflow document to the database only.
+    - ``ADDBUILD`` — add and build (generate input files).
+    - ``ADDBUILDEXECUTE`` — add, build, and execute the simulation.
+    """
     ADD = auto()
     ADDBUILD = auto()
     ADDBUILDEXECUTE = auto()
@@ -214,6 +220,15 @@ def getHermesWorkflowFromJSON(self, workflow: Union[dict, str], name=None, resou
         return hermesWFObj(workFlowJSON, name=name, Resource_path=resource)
 
     def updateDocumentWorkflow(self, document, workflow):
+        """Update a simulation document's workflow and parameters in the database.
+
+        Parameters
+        ----------
+        document : MetadataFrame
+            The simulation document to update.
+        workflow : hermes.workflow
+            The workflow object whose JSON and parameters will be stored.
+        """
         document.desc['workflow'] = workflow.json
         document.desc['parameters'] = workflow.parametersJSON
         document.save()