add docstring with example of usage

bdattoma · May 22, 2024 · 2efcda2 · 2efcda2
1 parent 05d9d87
commit 2efcda2
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/ods_ci/utils/scripts/fetch_tests.py b/ods_ci/utils/scripts/fetch_tests.py
@@ -1,3 +1,19 @@
+"""
+Examples
+Input:
+python3 ods_ci/utils/scripts/fetch_tests.py --test-repo git@github.com:red-hat-data-services/ods-ci.git --ref1 releases/2.8.0 --ref2-auto true --selector-attribute creatordate -A new-arg-file.txt
+Output:
+---| Computing differences |----
+Done. Found 30 new tests in releases/2.8.0 which were not present in origin/releases/2.7.0
+
+Input:
+python3 ods_ci/utils/scripts/fetch_tests.py --test-repo git@github.com:red-hat-data-services/ods-ci.git --ref1 master  --ref2-auto true --selector-attribute creatordate -A new-arg-file.txt
+Output:
+---| Computing differences |----
+Done. Found 14 new tests in master which were not present in origin/releases/2.9.0
+
+"""
+
 import argparse
 import os
 import shutil