From 15df326739c6c7686977a9a469e88efdbdc08a29 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Mon, 8 Jul 2024 14:26:02 +0200
Subject: Documenting get_calibration_status method

---
 src/argaze/utils/contexts/TobiiProGlasses2.py | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'src')

diff --git a/src/argaze/utils/contexts/TobiiProGlasses2.py b/src/argaze/utils/contexts/TobiiProGlasses2.py
index 7f45f32..3dd0161 100644
--- a/src/argaze/utils/contexts/TobiiProGlasses2.py
+++ b/src/argaze/utils/contexts/TobiiProGlasses2.py
@@ -975,6 +975,11 @@ class LiveStream(ArFeatures.LiveProcessingContext):
 		self.__calibration_id = None
 
 	def get_calibration_status(self) -> str:
+		"""Get calibration status.
+
+		Returns:
+			status: 'calibrating', 'calibrated', 'stale', 'uncalibrated' or 'failed' string
+		"""
 		
 		return self.__calibration_status		
 
-- 
cgit v1.1