From 26ad007b7c9bc891501bfef60c52ace47a0fd10f Mon Sep 17 00:00:00 2001
From: SkalskiP <piotr.skalski92@gmail.com>
Date: Wed, 6 Dec 2023 13:59:05 +0100
Subject: [PATCH] Add TriangleAnnotator example to documentation

---
 docs/annotators.md             | 25 +++++++++++++++++++++++++
 supervision/annotators/core.py | 17 +++++++++++++++++
 2 files changed, 42 insertions(+)

diff --git a/docs/annotators.md b/docs/annotators.md
index b7bbcd1f..f2dcd276 100644
--- a/docs/annotators.md
+++ b/docs/annotators.md
@@ -103,6 +103,27 @@
 
     </div>
 
+=== "Triangle"
+
+    ```python
+    >>> import supervision as sv
+
+    >>> image = ...
+    >>> detections = sv.Detections(...)
+
+    >>> triangle_annotator = sv.TriangleAnnotator()
+    >>> annotated_frame = triangle_annotator.annotate(
+    ...     scene=image.copy(),
+    ...     detections=detections
+    ... )
+    ```
+
+    <div class="result" markdown>
+
+    ![triangle-annotator-example](https://media.roboflow.com/supervision-annotator-examples/triangle-annotator-example.png){ align=center width="800" }
+
+    </div>
+
 === "Ellipse"
 
     ```python
@@ -330,6 +351,10 @@
 
 :::supervision.annotators.core.DotAnnotator
 
+## TriangleAnnotator
+
+:::supervision.annotators.core.TriangleAnnotator
+
 ## EllipseAnnotator
 
 :::supervision.annotators.core.EllipseAnnotator
diff --git a/supervision/annotators/core.py b/supervision/annotators/core.py
index be495c88..f61f818e 100644
--- a/supervision/annotators/core.py
+++ b/supervision/annotators/core.py
@@ -1311,6 +1311,23 @@ class TriangleAnnotator(BaseAnnotator):
 
         Returns:
             np.ndarray: The annotated image.
+
+        Example:
+            ```python
+            >>> import supervision as sv
+
+            >>> image = ...
+            >>> detections = sv.Detections(...)
+
+            >>> triangle_annotator = sv.TriangleAnnotator()
+            >>> annotated_frame = triangle_annotator.annotate(
+            ...     scene=image.copy(),
+            ...     detections=detections
+            ... )
+            ```
+
+        ![triangle-annotator-example](https://media.roboflow.com/
+        supervision-annotator-examples/triangle-annotator-example.png)
         """
         xy = detections.get_anchors_coordinates(anchor=self.position)
         for detection_idx in range(len(detections)):