Project docs

Matgenix · Mar 19, 2024 · 7993742 · 7993742
1 parent 0a9dbdb
commit 7993742
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/doc/source/_static/project_schema.html b/doc/source/_static/project_schema.html
diff --git a/src/jobflow_remote/config/base.py b/src/jobflow_remote/config/base.py
@@ -111,6 +111,13 @@ def to_logging(self) -> int:
 
 
 class BatchConfig(BaseModel):
+    """
+    Configuration for execution of batch jobs.
+
+    Allows to execute multiple Jobs in a single process executed on the
+    worker (e.g. SLURM job).
+    """
+
     jobs_handle_dir: Path = Field(
         description="Absolute path to a folder that will be used to store information to share with the jobs being executed"
     )
@@ -524,7 +531,7 @@ class Project(BaseModel):
     )
     queue: QueueConfig = Field(
         description="The configuration of the Store used to store the states of"
-        "the Jobs and the Flows",
+        " the Jobs and the Flows",
     )
     exec_config: dict[str, ExecutionConfig] = Field(
         default_factory=dict,