Id can be public

Signed-off-by: JadKHaddad <jadkhaddad@gmail.com>
JadKHaddad · Apr 13, 2024 · f9fd674 · f9fd674
1 parent ca21f21
commit f9fd674
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 7 deletions.
diff --git a/bmp180/src/error.rs b/bmp180/src/error.rs
@@ -8,11 +8,6 @@ pub enum BMP180Error<I2CError> {
     I2C(I2CError),
     /// Invalid device ID.
     InvalidId(u8),
-    /// Arithmetic error.
-    ///
-    /// Accurs on:
-    /// - Deviding by zero
-    /// - Overflow
-    /// - Underflow
+    /// Arithmetic error, like deviding by zero, overflow, etc.
     Arithmetic,
 }
diff --git a/bmp180/src/id.rs b/bmp180/src/id.rs
@@ -5,10 +5,12 @@
 #[cfg_attr(feature = "impl-defmt-format", derive(defmt::Format))]
 #[cfg_attr(feature = "impl-debug", derive(core::fmt::Debug))]
 pub enum Id {
+    /// Valid device ID.
     Valid = 0x55,
 }
 
 impl Id {
+    /// Check if the device ID is valid.
     pub fn is_valid(id: u8) -> bool {
         id == Id::Valid as u8
     }

diff --git a/bmp180/src/lib.rs b/bmp180/src/lib.rs
@@ -22,7 +22,7 @@ mod address;
 mod calibration;
 mod device;
 mod error;
-pub(crate) mod id;
+mod id;
 mod mode;
 mod register;
 
@@ -32,6 +32,7 @@ pub mod fuzz;
 pub use crate::address::Address;
 pub use crate::calibration::Calibration;
 pub use crate::error::BMP180Error;
+pub use crate::id::Id;
 pub use crate::mode::Mode;
 
 #[cfg(feature = "async")]