From 8ed7fc647e9a6b2aea7c680169cf835227e63ec9 Mon Sep 17 00:00:00 2001
From: sronilsson <sronilsson@gmail.com>
Date: Tue, 26 Nov 2024 14:20:31 -0500
Subject: [PATCH] kmeans

---
 simba/data_processors/circling_detector.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/simba/data_processors/circling_detector.py b/simba/data_processors/circling_detector.py
index ec1867d8d..d91f5de92 100644
--- a/simba/data_processors/circling_detector.py
+++ b/simba/data_processors/circling_detector.py
@@ -32,6 +32,10 @@ class CirclingDetector(ConfigReader):
 
         Circling is detected as `absent` when not present.
 
+    .. note::
+
+       We pass the names of the left and right ears, as the method will use body-parts to compute the `nape` location of the animal.
+
     :param Union[str, os.PathLike] data_dir: Path to directory containing pose-estimated body-part data in CSV format.
     :param Union[str, os.PathLike] config_path: Path to SimBA project config file.
     :param Optional[str] nose_name: The name of the pose-estimated nose body-part. Defaults to 'nose'.