Skip to content

Commit a157a54

Browse files
eldruinryankurte
andauthored
Apply suggestions from code review
Co-Authored-By: ryankurte <ryankurte@users.noreply.github.com>
1 parent f8e85ca commit a157a54

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

src/digital/v1_compat.rs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ where
5353
}
5454
}
5555

56-
/// Implementation of v1 StatefulOutputPin trait for v2 fallible pins
56+
/// Implementation of `v1::StatefulOutputPin` trait for `v2::StatefulOutputPin` fallible pins
57+
/// where errors will panic.
5758
#[cfg(feature = "unproven")]
5859
#[allow(deprecated)]
5960
impl <T, E> v1::StatefulOutputPin for OldOutputPin<T>
@@ -82,7 +83,7 @@ where
8283
T: v2::OutputPin<Error=E>,
8384
E: core::fmt::Debug,
8485
{
85-
/// Create an OldInputPin wrapper around a v2::InputPin
86+
/// Create an `OldInputPin` wrapper around a `v2::InputPin`.
8687
pub fn new(pin: T) -> Self {
8788
Self{pin}
8889
}
@@ -104,7 +105,8 @@ where
104105
}
105106
}
106107

107-
/// Implementation of v0.2 InputPin trait for v0.3 fallible pins
108+
/// Implementation of `v1::InputPin` trait for `v2::InputPin` fallible pins
109+
/// where errors will panic.
108110
#[cfg(feature = "unproven")]
109111
#[allow(deprecated)]
110112
impl <T, E> v1::InputPin for OldInputPin<T>
@@ -248,4 +250,4 @@ mod tests {
248250
i.is_low();
249251
}
250252

251-
}
253+
}

src/digital/v2.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
//! Digital I/O
22
//!
3-
//! Version 2 / vallible traits. Infallable implementations should set Error to `!`.
3+
//! Version 2 / fallible traits. Infallable implementations should set Error to `!`.
44
55
/// Single digital push-pull output pin
66
pub trait OutputPin {

0 commit comments

Comments
 (0)