Skip to content

Commit 2871568

Browse files
committed
Add extra docs to McycleDelay::new
1 parent d50928b commit 2871568

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/delay.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ pub struct McycleDelay {
88
}
99

1010
impl McycleDelay {
11-
/// Constructs the delay provider
11+
/// Constructs the delay provider.
12+
/// `ticks_second` should be the clock speed of the core, in Hertz
1213
#[inline(always)]
1314
pub fn new(ticks_second: u32) -> Self {
1415
Self { ticks_second }

0 commit comments

Comments
 (0)