Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-12 01:24:17 +00:00
Code Issues Releases Activity

doc/customdevices: use correct default argument

Browse Source 
Make it match the implementation.
This commit is contained in:
Laurens Valk
2019-12-10 13:25:06 +01:00
parent 2e530a4b30
commit d78db6aefb
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pybricks/customdevices.py
+3 -3
View File
@@ -109,11 +109,11 @@ class UARTDevice():
baudrate (int): Baudrate of the UART device.
timeout (:ref:`time`): How long to wait
during :meth:`.read` before giving up. If you choose ``None``,
it will wait forever. (*Default*: ``None``)
it will wait forever (*Default*: ``None``).
"""
pass
def read(self, length):
def read(self, length=1):
"""Read a given number of bytes from the buffer.
Your program will wait until the requested number of bytes are
@@ -121,7 +121,7 @@ class UARTDevice():
exception is raised.
Arguments:
length (``int``): How many bytes to read.
length (``int``): How many bytes to read (*Default*: 1).
Returns:
``bytes``: Bytes returned from the device.