Merge pull request #704 from ithinuel/document-i2c-error-derives

Document what's happening with derives on i2c::Error
rp-rs · Oct 21, 2023 · 14b6ee3 · 14b6ee3
2 parents 9c17a2d + 51badca
commit 14b6ee3
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/rp2040-hal/src/i2c.rs b/rp2040-hal/src/i2c.rs
@@ -72,6 +72,8 @@ impl I2cDevice for pac::I2C1 {
 
 /// I2C error
 #[non_exhaustive]
+// when eh1_0_alpha is set, Debug & defmt::Format are manually implemented
+// to rely on eh1.0's ErrorKind.
 #[cfg_attr(not(feature = "eh1_0_alpha"), derive(Debug))]
 #[cfg_attr(
     all(feature = "defmt", not(feature = "eh1_0_alpha")),