From 5e685a9c6faeb764c0b689bc736ed00736bfd6b6 Mon Sep 17 00:00:00 2001 From: Damien George Date: Mon, 28 Mar 2022 17:10:33 +1100 Subject: [PATCH] docs/library/machine.I2S: Clarify what rate refers to. Signed-off-by: Damien George --- docs/library/machine.I2S.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/library/machine.I2S.rst b/docs/library/machine.I2S.rst index abfbb08780..d4e5ac9433 100644 --- 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