Add TODO comment

Author: usbalbin

src/mcpwm/operator.rs

@@ -66,8 +66,9 @@ where
         todo!()
     }
 
-    // TODO: make sure the peak related description is accurate
     /// Set duty as in the range 0 to timers peak value
+    /// 
+    /// NOTE: The compare value shouldn’t exceed timer’s count peak, otherwise, the compare event will never got triggered.
     pub fn set_duty_a(&mut self, duty: Duty) -> Result<(), EspError> {
         todo!()
     }
@@ -84,7 +85,7 @@ where
         todo!()
     }
 
-    /// Set duty as percentage between 0.0 and 100.0 for output B
+    /// NOTE: The compare value shouldn’t exceed timer’s count peak, otherwise, the compare event will never got triggered.
     pub fn set_duty_b(&mut self, duty: Duty) -> Result<(), EspError> {
         todo!()
     }

src/mcpwm/timer.rs

@@ -115,6 +115,7 @@ impl<const N: u8, G: Group> Timer<N, G> {
         }
     }
 
+    // TODO: make sure this description is accurate
     /// Get number of ticks per period
     /// 
     /// Use this when working with the frequency or the period
@@ -126,6 +127,7 @@ impl<const N: u8, G: Group> Timer<N, G> {
         self.period_ticks
     }
 
+    // TODO: make sure this description is accurate
     /// This is the maximum value that the comparator will see
     /// 
     /// Use this working with the duty