From 74e7f4a22717a73f735caa97589c9603091016e6 Mon Sep 17 00:00:00 2001
From: Jacob Rosenthal <jacobrosenthal@gmail.com>
Date: Mon, 1 Nov 2021 13:16:24 -0700
Subject: [PATCH] comments

---
 embassy-nrf/src/pwm.rs | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/embassy-nrf/src/pwm.rs b/embassy-nrf/src/pwm.rs
index 3594e6afd..947cd873b 100644
--- a/embassy-nrf/src/pwm.rs
+++ b/embassy-nrf/src/pwm.rs
@@ -66,7 +66,7 @@ pub enum SequenceMode {
 pub struct SequenceConfig<'a> {
     /// Selects up mode or up-and-down mode for the counter
     pub counter_mode: CounterMode,
-    // Top value to be compared against buffer values
+    /// Top value to be compared against buffer values
     pub top: u16,
     /// Configuration for PWM_CLK
     pub prescaler: Prescaler,
@@ -170,7 +170,7 @@ impl<'d, T: Instance> Pwm<'d, T> {
         }
     }
 
-    /// Returns a configured pwm that has had start called on it
+    /// Play a `SequenceConfig` sequence instead of a stable `set_duty` output
     pub fn play_sequence(&self, config: SequenceConfig) -> Result<(), Error> {
         slice_in_ram_or(config.sequence, Error::DMABufferNotInDataMemory)?;
 
@@ -233,6 +233,7 @@ impl<'d, T: Instance> Pwm<'d, T> {
 
                 r.loop_.write(|w| unsafe { w.cnt().bits(times) });
 
+                // we can subtract 1 by starting at seq1 instead of seq0
                 if odd {
                     // tasks_seqstart doesnt exist in all svds so write its bit instead
                     r.tasks_seqstart[1].write(|w| unsafe { w.bits(0x01) });