From 420ca5b19fa1db8e14b386c040dc54a79e07bab4 Mon Sep 17 00:00:00 2001 From: Renato Durrer Date: Wed, 3 Apr 2024 13:36:02 +0200 Subject: [PATCH] Improve the way --help prints the docstring. --- src/stratigraphy/main.py | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/src/stratigraphy/main.py b/src/stratigraphy/main.py index 1670a4ac..c0ff1876 100644 --- a/src/stratigraphy/main.py +++ b/src/stratigraphy/main.py @@ -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