📘 docs updates for Position and get_anchor_coordinates

SkalskiP · SkalskiP · commit 1b8ff617c372 · 2023-09-28T12:13:52.000+02:00
diff --git a/docs/geometry/core.md b/docs/geometry/core.md
@@ -0,0 +1,3 @@
+## Position
+
+:::supervision.geometry.core.Position
diff --git a/supervision/detection/core.py b/supervision/detection/core.py
@@ -644,15 +644,23 @@ def __all_not_none(item_list: List[Any]):
 
     def get_anchor_coordinates(self, anchor: Position) -> np.ndarray:
         """
-        Returns the bounding box coordinates for a specific anchor.
+        Calculates and returns the coordinates of a specific anchor point
+        within the bounding boxes defined by the `xyxy` attribute. The anchor
+        point can be any of the predefined positions in the `Position` enum,
+        such as `CENTER`, `CENTER_LEFT`, `BOTTOM_RIGHT`, etc.
 
         Args:
-            anchor (Position): Position of bounding box anchor
-                for which to return the coordinates.
+            anchor (Position): An enum specifying the position of the anchor point
+                within the bounding box. Supported positions are defined in the
+                `Position` enum.
 
         Returns:
-            np.ndarray: An array of shape `(n, 2)` containing the bounding
-                box anchor coordinates in format `[x, y]`.
+            np.ndarray: An array of shape `(n, 2)`, where `n` is the number of bounding
+                boxes. Each row contains the `[x, y]` coordinates of the specified
+                anchor point for the corresponding bounding box.
+
+        Raises:
+            ValueError: If the provided `anchor` is not supported.
         """
         if anchor == Position.CENTER:
             return np.array(
diff --git a/supervision/geometry/core.py b/supervision/geometry/core.py
@@ -6,6 +6,9 @@
 
 
 class Position(Enum):
+    """
+    Enum representing the position of an anchor point.
+    """
     CENTER = "CENTER"
     CENTER_LEFT = "CENTER_LEFT"
     CENTER_RIGHT = "CENTER_RIGHT"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+## Position`
	`2`	`+`
	`3`	`+:::supervision.geometry.core.Position`