Skip to content

Commit

Permalink
Minor: Added a doscstring to common run_minimal()
Browse files Browse the repository at this point in the history
  • Loading branch information
alongd committed Oct 31, 2024
1 parent d8ac67a commit 8bfc3c1
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion tests/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,18 @@ def run_minimal(project: Optional[str] = None,
iteration: Optional[int] = None,
set_paths: bool = False,
) -> T3:
"""A helper function for running the minimal example"""
"""
A helper function for running the minimal example.
Args:
project (str, optional): The project name.
project_directory (str, optional): The project directory.
iteration (int, optional): The iteration number.
set_paths (bool, optional): Whether to set the paths.
Returns:
T3: The T3 object.
"""
minimal_input = os.path.join(EXAMPLES_BASE_PATH, 'minimal', 'input.yml')
input_dict = read_yaml_file(path=minimal_input)
input_dict['verbose'] = 10
Expand Down

0 comments on commit 8bfc3c1

Please sign in to comment.