浏览代码

Add extra docs to `McycleDelay::new`

Joey Harrison 2 年之前
父节点
当前提交
28715684db
共有 1 个文件被更改,包括 2 次插入1 次删除
  1. 2 1
      src/delay.rs

+ 2 - 1
src/delay.rs

@@ -8,7 +8,8 @@ pub struct McycleDelay {
 }
 }
 
 
 impl McycleDelay {
 impl McycleDelay {
-    /// Constructs the delay provider
+    /// Constructs the delay provider.
+    /// `ticks_second` should be the clock speed of the core, in Hertz
     #[inline(always)]
     #[inline(always)]
     pub fn new(ticks_second: u32) -> Self {
     pub fn new(ticks_second: u32) -> Self {
         Self { ticks_second }
         Self { ticks_second }