From 520067c07594fc870476649e06689905a9b7e1a7 Mon Sep 17 00:00:00 2001 From: maugde Date: Fri, 24 May 2024 14:48:50 +0200 Subject: [PATCH] feat: add comments to `cli.py` --- src/antares_web_installer/cli.py | 4 +++- tests/results/nt/examples/archives/.placeholder | 0 tests/results/nt/examples/internal_studies/.placeholder | 0 tests/results/nt/examples/studies/.placeholder | 0 tests/results/nt/logs/.placeholder | 0 tests/results/nt/matrices/.placeholder | 0 tests/results/nt/tmp/.placeholder | 0 7 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 tests/results/nt/examples/archives/.placeholder create mode 100644 tests/results/nt/examples/internal_studies/.placeholder create mode 100644 tests/results/nt/examples/studies/.placeholder create mode 100644 tests/results/nt/logs/.placeholder create mode 100644 tests/results/nt/matrices/.placeholder create mode 100644 tests/results/nt/tmp/.placeholder diff --git a/src/antares_web_installer/cli.py b/src/antares_web_installer/cli.py index c49253f..df0f2aa 100644 --- a/src/antares_web_installer/cli.py +++ b/src/antares_web_installer/cli.py @@ -46,7 +46,9 @@ ) def install_cli(src_dir: str, target_dir: str, **kwargs) -> None: """ - Install Antares Web at the right file locations. + Install Antares Web Server sources. + Takes two positional argument : 'src_dir' source directory to copy files from and 'target' directory + to paste files to. """ target_dir = Path(target_dir) src_dir = Path(src_dir) diff --git a/tests/results/nt/examples/archives/.placeholder b/tests/results/nt/examples/archives/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/nt/examples/internal_studies/.placeholder b/tests/results/nt/examples/internal_studies/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/nt/examples/studies/.placeholder b/tests/results/nt/examples/studies/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/nt/logs/.placeholder b/tests/results/nt/logs/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/nt/matrices/.placeholder b/tests/results/nt/matrices/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/tests/results/nt/tmp/.placeholder b/tests/results/nt/tmp/.placeholder new file mode 100644 index 0000000..e69de29