Skip to content

Commit ac0ffc5

Browse files
committed
_bit_transpose: fix docs
1 parent c284728 commit ac0ffc5

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

shared-bindings/_bit_transpose/__init__.c

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,13 @@
3636
//| routine for performing the transformation."""
3737
//|
3838

39-
//| def bit_transpose(input: _typing.ReadableBuffer, *, output: Optional[_typing.WritableBuffer]=None):
40-
//| """Convert a sequence of 8*N pixel values into a single stream of bytes suitable for sending via a parallel conversion method (PioPixl8)
39+
//| def bit_transpose(input: _typing.ReadableBuffer, *, num_strands:int = 8, output: Optional[_typing.WriteableBuffer]=None) -> WriteableBuffer:
40+
//| """Convert a sequence of pixel values into a single stream of bytes suitable for sending via a parallel conversion method (PioPixl8)
41+
//|
42+
//| The number of bytes in the input buffer must be a multiple of the number of strands.
43+
//|
44+
//| If specified output buffer must be big enough for the output, ``len(input) * 8 // num_strands``. To get a properly sized buffer,
45+
//| you can also pass in ``output=None`` once, then re-use the return value in future calls.
4146
//|
4247
//| Returns the output buffer if specified (which must be big enough to hold the result), otherwise a freshly allocated buffer."""
4348
//| ...

0 commit comments

Comments
 (0)