From 7bb79c6600e594c6504dd20d704f521db6854f2a Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Mon, 20 Feb 2023 15:07:16 +0100
Subject: Commenting what circle_intersection fuction returns

---
 src/argaze/AreaOfInterest/AOIFeatures.py | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

(limited to 'src')

diff --git a/src/argaze/AreaOfInterest/AOIFeatures.py b/src/argaze/AreaOfInterest/AOIFeatures.py
index ea57866..c1df8f1 100644
--- a/src/argaze/AreaOfInterest/AOIFeatures.py
+++ b/src/argaze/AreaOfInterest/AOIFeatures.py
@@ -148,9 +148,15 @@ class AreaOfInterest(numpy.ndarray):
         return tuple(numpy.rint(Lp).astype(int))
 
     def circle_intersection(self, center: tuple, radius: float) -> Tuple[numpy.array, float, float]:
-        """Get intersection shape with a circle, intersection area / AOI area ration and intersection area / circle area ration.
+        """Get intersection shape with a circle, intersection area / AOI area ratio and intersection area / circle area ratio.
         .. warning::
-           Available for 2D AOI only."""
+           Available for 2D AOI only.
+
+           * **Returns:** 
+            - intersection shape, 
+            - intersection aoi ratio,
+            - intersection circle ratio
+        """
 
         assert(self.dimension == 2)
 
-- 
cgit v1.1