review

PEtab-dev · Jan 6, 2025 · 6d89e04 · 6d89e04
1 parent 8db0880
commit 6d89e04
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/petab/v1/problem.py b/petab/v1/problem.py
@@ -1215,8 +1215,8 @@ class ProblemConfig(BaseModel):
     def to_yaml(self, filename: str | Path):
         """Write the configuration to a YAML file.
 
-        filename: Destination file name. The parent directory will be created
-            if necessary.
+        :param filename: Destination file name. The parent directory will be
+            created if necessary.
         """
         from .yaml import write_yaml
 

diff --git a/petab/v2/problem.py b/petab/v2/problem.py
@@ -993,6 +993,7 @@ class ModelFile(BaseModel):
 class SubProblem(BaseModel):
     """A `problems` object in the PEtab problem configuration."""
 
+    # TODO: consider changing str to Path
     model_files: dict[str, ModelFile] | None = {}
     measurement_files: list[str | AnyUrl] = []
     condition_files: list[str | AnyUrl] = []
@@ -1031,8 +1032,8 @@ class ProblemConfig(BaseModel):
     def to_yaml(self, filename: str | Path):
         """Write the configuration to a YAML file.
 
-        filename: Destination file name. The parent directory will be created
-            if necessary.
+        :param filename: Destination file name. The parent directory will be
+            created if necessary.
         """
         from ..v1.yaml import write_yaml