From 0edd5527161809dfbc0c76e39c462e3a4f00beb7 Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Sat, 23 Nov 2024 22:49:30 +0100 Subject: Improve documentation. (#32) * Use `non_exhaustive`. * Improve docs. --- src/devices/common.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'src/devices/common.rs') diff --git a/src/devices/common.rs b/src/devices/common.rs index 53cb050..66a6d97 100644 --- a/src/devices/common.rs +++ b/src/devices/common.rs @@ -1,4 +1,4 @@ -//! Common functions +//! Common functions. use crate::{devices::OperatingMode, Ads1x1x, BitFlags, Config, Error, Register}; @@ -30,7 +30,7 @@ where Ok(()) } - /// Read whether a measurement is currently in progress. + /// Checks whether a measurement is currently in progress. pub fn is_measurement_in_progress(&mut self) -> Result> { let config = Config { bits: self.read_register(Register::CONFIG)?, -- cgit v1.2.3-54-g00ecf