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

Signed-off-by: Damien George <damien@micropython.org>
3 years ago · 5e685a9c6f
1 changed files with 2 additions and 1 deletions
--- 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