DOC: Add doc on keywords

pmgbergen · Jul 24, 2024 · eded112 · eded112
1 parent c5d69b4
commit eded112
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/darsia/assistants/rectangle_selection_assistant.py b/src/darsia/assistants/rectangle_selection_assistant.py
@@ -23,6 +23,10 @@ def __init__(self, img: darsia.Image, **kwargs) -> None:
         Args:
             img (darsia.Image): Image to select a rectangle in.
             **kwargs: Additional arguments.
+                - background (darsia.Image): Background image to display.
+                - name (str): Name of assistant / short version of instructions.
+                - coordinates (bool): Flag controlling whether to return coordinates or voxels.
+                - labels (darsia.Image): Labels for the image.
 
         """
         if img is None: