summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Hinch <peter@hinch.me.uk>2021-09-10 14:02:35 +0100
committerDamien George <damien@micropython.org>2021-09-13 18:21:46 +1000
commit4552f1816b194b22befb199d0adc3a67df2344b3 (patch)
tree5d0d65f48687671bf437a0cd2a46ac49d58b5b4b
parentc7842f479836e4aec449a83ddf2907d28dde6027 (diff)
docs/library/machine.I2S.rst: Specify that I2S.shift args are kw-only.
-rw-r--r--docs/library/machine.I2S.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/library/machine.I2S.rst b/docs/library/machine.I2S.rst
index 45877a5ae..d64fba33e 100644
--- a/docs/library/machine.I2S.rst
+++ b/docs/library/machine.I2S.rst
@@ -134,7 +134,7 @@ Methods
Setting a callback changes the ``write`` and ``readinto`` methods to non-blocking operation.
``handler`` is called in the context of the MicroPython scheduler.
-.. staticmethod:: I2S.shift(buf, bits, shift)
+.. staticmethod:: I2S.shift(*, buf, bits, shift)
bitwise shift of all samples contained in ``buf``. ``bits`` specifies sample size in bits. ``shift`` specifies the number of bits to shift each sample.
Positive for left shift, negative for right shift.