#63 Add method description

DEIS-Tools · Aug 28, 2024 · f5583f0 · f5583f0
1 parent 804cb36
commit f5583f0
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/py_driver/driver.py b/py_driver/driver.py
@@ -235,6 +235,10 @@ def update_state(self, tube=None, quick=False, initial=False):
         raise SensorError(f"Failed to retrieve new state, got {state}.")
 
     def _underflow_check(self):
+        """
+        Checks whether underflow occurs, i.e., the outflow pump is pumping while water is lower than
+        lowest allowed level. This check prevents the outflow pump from pumping air.
+        """
         TAG = "UNDERFLOW_CHECK"
         while True:
             if not self.ready():