Skip to content

Commit b82ca88

Browse files
committed
doc
1 parent 146dc0e commit b82ca88

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

petab/v2/core.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1402,7 +1402,12 @@ def to_files(self, base_path: str | Path | None) -> None:
14021402
by the `rel_path` and `base_path` of their respective objects.
14031403
14041404
This expects that all objects have their `rel_path` and `base_path`
1405-
set correctly, which is usually done by Problem.from_yaml().
1405+
set correctly, which is usually done by :meth:`Problem.from_yaml`.
1406+
1407+
:param base_path:
1408+
The base path the yaml file and tables will be written to.
1409+
If ``None``, the `base_path` of the individual tables and
1410+
:obj:`Problem.config.base_path` will be used.
14061411
"""
14071412
config = copy.deepcopy(self.config) or ProblemConfig(
14081413
format_version="2.0.0"

0 commit comments

Comments
 (0)