Update test/integration/docker/image.py

Co-authored-by: Christoph Kuhnke <[email protected]>
exasol · Jan 29, 2024 · bb4f130 · bb4f130
1 parent 7ccefc2
commit bb4f130
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/test/integration/docker/image.py b/test/integration/docker/image.py
@@ -25,6 +25,13 @@ def __init__(self, reason, build_log: List[Dict[str, Any]]):
 
 
 def image(request, name: str, print_log=False, **kwargs) -> Image:
+    """
+    Create a Docker image.
+    The function supports a pair of pytest cli options with a suffix derived from parameter ``name``:
+    Option `--docker-image-(suffix)` specifies the name of an existing image to be used 
+    instead of creating a new one.
+    Option `--keep-docker-image-(suffix)` skips removing the image after test execution.
+    """
     base_command_line = name.replace("_", "-")
     image_tag = request.config.getoption(f"--docker-image-{base_command_line}")
     keep_image = request.config.getoption(f"--keep-docker-image-{base_command_line}")