djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/library/machine.I2S.rst: Specify that I2S.shift args are kw-only.

This commit is contained in:
Peter Hinch 2021-09-10 14:02:35 +01:00 committed by Damien George
parent c7842f4798
commit 4552f1816b
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/library/machine.I2S.rst
View File

@ -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.