summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDamien George <damien@micropython.org>2022-03-28 17:10:33 +1100
committerDamien George <damien@micropython.org>2022-03-29 11:44:08 +1100
commit5e685a9c6faeb764c0b689bc736ed00736bfd6b6 (patch)
tree5dd803f4756a4a81a278cc03eb956d012fb46d3d
parent726628584507d1b043fa28e9adf122acb4b40781 (diff)
docs/library/machine.I2S: Clarify what rate refers to.
Signed-off-by: Damien George <damien@micropython.org>
-rw-r--r--docs/library/machine.I2S.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/library/machine.I2S.rst b/docs/library/machine.I2S.rst
index abfbb0878..d4e5ac943 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