Skip to content

Commit d76bd2f

Browse files
author
taradiddles
committed
add docstrings for the wait_nnn_ready methods about which modes are supported
1 parent 43e0e07 commit d76bd2f

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

adafruit_dps310.py

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,13 @@ def temperature_ready(self):
315315
return self._temp_ready
316316

317317
def wait_temperature_ready(self):
318-
"""Wait until a temperature measurement is available"""
318+
"""Wait until a temperature measurement is available.
319+
320+
To avoid waiting indefinitely this function raises an
321+
error if the sensor isn't configured for temperate measurements,
322+
ie. `Mode.ONE_TEMPERATURE`, `Mode.CONT_TEMP` or `Mode.CONT_PRESTEMP`.
323+
See the `Mode` documentation for details.
324+
"""
319325
if (
320326
self._mode_bits == Mode.IDLE
321327
or self._mode_bits == Mode.ONE_PRESSURE
@@ -334,7 +340,13 @@ def pressure_ready(self):
334340
return self._pressure_ready
335341

336342
def wait_pressure_ready(self):
337-
"""Wait until a pressure measurement is available"""
343+
"""Wait until a pressure measurement is available
344+
345+
To avoid waiting indefinitely this function raises an
346+
error if the sensor isn't configured for pressure measurements,
347+
ie. `Mode.ONE_PRESSURE`, `Mode.CONT_PRESSURE` or `Mode.CONT_PRESTEMP`
348+
See the `Mode` documentation for details.
349+
"""
338350
if (
339351
self._mode_bits == Mode.IDLE
340352
or self._mode_bits == Mode.ONE_TEMPERATURE

0 commit comments

Comments
 (0)