From fed7d27136f02ec74b0996445c69fa969ea6beb7 Mon Sep 17 00:00:00 2001
From: Daniel <d.brummerloh@gmail.com>
Date: Mon, 11 Dec 2023 00:09:28 +0100
Subject: [PATCH] add example

---
 pytest_abra/coordinator.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/pytest_abra/coordinator.py b/pytest_abra/coordinator.py
index 84d08a5..e0f2162 100644
--- a/pytest_abra/coordinator.py
+++ b/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.
         """