From bc7266394ddba3d6128cc9de131109c2454f3d05 Mon Sep 17 00:00:00 2001
From: huntc <huntchr@gmail.com>
Date: Fri, 4 Feb 2022 11:48:08 +1100
Subject: [PATCH] Clarify why we need the mut buffer

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

diff --git a/embassy-nrf/src/pwm.rs b/embassy-nrf/src/pwm.rs
index a4bc94765..e561f0383 100644
--- a/embassy-nrf/src/pwm.rs
+++ b/embassy-nrf/src/pwm.rs
@@ -428,6 +428,8 @@ impl Default for SequenceConfig {
 #[non_exhaustive]
 pub struct Sequence<'d> {
     /// The words comprising the sequence. Must not exceed 32767 words.
+    /// The reason for this buffer to be mutable is so that stopping
+    /// the PWM can relinquish the sequence for subsequent modification.
     pub words: &'d mut [u16],
     /// Configuration associated with the sequence.
     pub config: SequenceConfig,