pytest_abra/coordinator.py

@@ -91,6 +91,13 @@ class Coordinator:
     def create_runner_dict(recipes_dir: Path) -> dict[str, type[Runner]]:
         """Creates a dictionary holding all the RunnerClasses that can be discovered in recipes_dir
 
+        example:
+        RUNNER_DICT: dict[str, type["Runner"]] = {
+            "authentik": RunnerAuthentik,
+            "wordpress": RunnerWordpress,
+            "nextcloud": RunnerNextcloud,
+        }
+
         The Runner classes are automatically imported with importlib. The imports are successful
         because recipes_dir is added to sys.path.
         """