From 5babc44cac753e8be405ef6830396299e013e1d7 Mon Sep 17 00:00:00 2001 From: yucongalicechen Date: Thu, 5 Sep 2024 17:45:00 -0400 Subject: [PATCH] edit output directory docstring --- src/diffpy/labpdfproc/tools.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/diffpy/labpdfproc/tools.py b/src/diffpy/labpdfproc/tools.py index 3100596..30520d6 100644 --- a/src/diffpy/labpdfproc/tools.py +++ b/src/diffpy/labpdfproc/tools.py @@ -17,15 +17,14 @@ def set_output_directory(args): args argparse.Namespace the arguments from the parser - Returns - ------- - pathlib.PosixPath that contains the full path of the output directory - it is determined as follows: If user provides an output directory, use it. Otherwise, we set it to the current directory if nothing is provided. We then create the directory if it does not exist. + Returns + ------- + a Path object that contains the full path of the output directory """ output_dir = Path(args.output_directory).resolve() if args.output_directory else Path.cwd().resolve() output_dir.mkdir(parents=True, exist_ok=True)