From ce324942d4fd2f41be204c4cc3a307bce5c3e30a Mon Sep 17 00:00:00 2001
From: Huyen Nguyen <48179958+huyenngn@users.noreply.github.com>
Date: Mon, 16 Dec 2024 21:58:58 +0100
Subject: [PATCH] docs: Update custom_diagram docs

Co-authored-by: Martin Lehmann <martin.lehmann@deutschebahn.com>
---
 .../collectors/custom.py                      |  2 +-
 docs/custom_diagram.md                        | 25 +++++++++++--------
 2 files changed, 15 insertions(+), 12 deletions(-)

diff --git a/capellambse_context_diagrams/collectors/custom.py b/capellambse_context_diagrams/collectors/custom.py
index fde8399..d378dc4 100644
--- a/capellambse_context_diagrams/collectors/custom.py
+++ b/capellambse_context_diagrams/collectors/custom.py
@@ -33,7 +33,7 @@ class CustomCollector:
 
     def __init__(
         self,
-        diagram: context.CustomDiagram,
+        diagram: context.ContextDiagram,
         params: dict[str, t.Any],
     ) -> None:
         self.diagram = diagram
diff --git a/docs/custom_diagram.md b/docs/custom_diagram.md
index 3f4f7de..98d1c1c 100644
--- a/docs/custom_diagram.md
+++ b/docs/custom_diagram.md
@@ -5,7 +5,8 @@
 
 # Custom Diagram
 
-`Custom diagram`s let's you create custom diagrams based on the data in the model. You define the data collection using an iterable and `Custom diagram` takes care of the rest.
+`Custom diagram`s let you create custom diagrams based on the data in the model. You define the data collection using an iterable, and `Custom diagram` takes care of the rest.
+
 You can access `.custom_diagram` on any supported model element.
 
 ??? example "Custom Diagram of `PP 1 `"
@@ -13,19 +14,21 @@ You can access `.custom_diagram` on any supported model element.
     ``` py
     import capellambse
 
-    visited = set()
-
     def _collector(
         target: m.ModelElement,
     ) -> cabc.Iterator[m.ModelElement]:
-        if target.uuid in visited:
-            return
-        visited.add(target.uuid)
-        for link in target.links:
-            yield link
-            yield from _collector(link.source)
-            yield from _collector(link.target)
-
+        visited = set()
+        def collector(
+            target: m.ModelElement,
+        ) -> cabc.Iterator[m.ModelElement]:
+            if target.uuid in visited:
+                return
+            visited.add(target.uuid)
+            for link in target.links:
+                yield link
+                yield from collector(link.source)
+                yield from collector(link.target)
+        yield from collector(target)
 
     model = capellambse.MelodyModel("tests/data/ContextDiagram.aird")
     obj = model.by_uuid("c403d4f4-9633-42a2-a5d6-9e1df2655146")