diff options
| author | Markus Reiter <me@reitermark.us> | 2024-11-23 22:49:30 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-11-23 22:49:30 +0100 |
| commit | 0edd5527161809dfbc0c76e39c462e3a4f00beb7 (patch) | |
| tree | bb55dd2015752ce100d21682a5f452b9f5c4d208 /src/devices/common.rs | |
| parent | d3af2b6074e8698b8b83f79758e23070a8b80002 (diff) | |
| download | ads1x1x-async-0edd5527161809dfbc0c76e39c462e3a4f00beb7.tar.gz ads1x1x-async-0edd5527161809dfbc0c76e39c462e3a4f00beb7.tar.xz ads1x1x-async-0edd5527161809dfbc0c76e39c462e3a4f00beb7.zip | |
Improve documentation. (#32)
* Use `non_exhaustive`.
* Improve docs.
Diffstat (limited to 'src/devices/common.rs')
| -rw-r--r-- | src/devices/common.rs | 4 |
1 files changed, 2 insertions, 2 deletions
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<bool, Error<E>> { let config = Config { bits: self.read_register(Register::CONFIG)?, |