Skip to content

Commit 1351786

Browse files
committed
Clarify bits_per_word override documentation
Update documentation for read, write, and transfer methods to indicate that the default value will fall back to the underlying bits_per_word setting, not 8 as the documentation previously suggested. Fixes #2
1 parent 92f304a commit 1351786

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

spi.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -369,8 +369,8 @@ def write(self, data, speed=0, bits_per_word=0, delay=0):
369369
data: List of words to write
370370
speed: Optional temporary bitrate override in Hz. 0 (default)
371371
uses existing spidev speed setting.
372-
bits_per_word: Optional temporary bits_per_word override. 0 (
373-
default) is equivalent to 8 bits per word.
372+
bits_per_word: Optional temporary bits_per_word override. 0
373+
(default) will use the current bits_per_word setting.
374374
delay: Optional delay in usecs between sending the last bit and
375375
deselecting the chip select line. 0 (default) for no delay.
376376
"""
@@ -390,8 +390,8 @@ def read(self, length, speed=0, bits_per_word=0, delay=0):
390390
length: Integer count of words to read
391391
speed: Optional temporary bitrate override in Hz. 0 (default)
392392
uses existing spidev speed setting.
393-
bits_per_word: Optional temporary bits_per_word override. 0 (
394-
default) is equivalent to 8 bits per word.
393+
bits_per_word: Optional temporary bits_per_word override. 0
394+
(default) will use the current bits_per_word setting.
395395
delay: Optional delay in usecs between sending the last bit and
396396
deselecting the chip select line. 0 (default) for no delay.
397397
@@ -413,8 +413,8 @@ def transfer(self, data, speed=0, bits_per_word=0, delay=0):
413413
data: List of words to transmit
414414
speed: Optional temporary bitrate override in Hz. 0 (default)
415415
uses existing spidev speed setting.
416-
bits_per_word: Optional temporary bits_per_word override. 0 (
417-
default) is equivalent to 8 bits per word.
416+
bits_per_word: Optional temporary bits_per_word override. 0
417+
(default) will use the current bits_per_word setting.
418418
delay: Optional delay in usecs between sending the last bit and
419419
deselecting the chip select line. 0 (default) for no delay.
420420

0 commit comments

Comments
 (0)