docs/library/machine.I2S: Clarify what rate refers to.

Signed-off-by: Damien George <damien@micropython.org>
micropython · Mar 29, 2022 · 5e685a9 · 5e685a9
1 parent 7266285
commit 5e685a9
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/docs/library/machine.I2S.rst b/docs/library/machine.I2S.rst
@@ -95,7 +95,8 @@ Constructor
      - ``mode`` specifies receive or transmit
      - ``bits`` specifies sample size (bits), 16 or 32
      - ``format`` specifies channel format, STEREO or MONO
-     - ``rate`` specifies audio sampling rate (samples/s)
+     - ``rate`` specifies audio sampling rate (Hz);
+       this is the frequency of the ``ws`` signal
      - ``ibuf`` specifies internal buffer length (bytes)
 
    For all ports, DMA runs continuously in the background and allows user applications to perform other operations while