Skip to content

Commit

Permalink
Improve the way --help prints the docstring.
Browse files Browse the repository at this point in the history
  • Loading branch information
redur committed Apr 3, 2024
1 parent 7a37f7b commit 420ca5b
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions src/stratigraphy/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,14 @@ def start_pipeline(
depth intervals. The input directory should contain pdf files with boreholes data. The algorithm can deal
with borehole profiles of multiple pages.
Args:\n
input_directory (Path): The directory containing the pdf files.\n
ground_truth_path (Path): The path to the ground truth file json file.\n
out_directory (Path): The directory to store the evaluation results.\n
predictions_path (Path): The path to the predictions file.\n
skip_draw_predictions (bool, optional): Whether to skip drawing predictions on pdf pages. Defaults to False.\n
draw_lines (bool, optional): Whether to draw lines on pdf pages. Defaults to False.\n
\f
Args:
input_directory (Path): The directory containing the pdf files.
ground_truth_path (Path): The path to the ground truth file json file.
out_directory (Path): The directory to store the evaluation results.
predictions_path (Path): The path to the predictions file.
skip_draw_predictions (bool, optional): Whether to skip drawing predictions on pdf pages. Defaults to False.
draw_lines (bool, optional): Whether to draw lines on pdf pages. Defaults to False.
""" # noqa: D301
if mlflow_tracking:
import mlflow
Expand Down

0 comments on commit 420ca5b

Please sign in to comment.