summaryrefslogtreecommitdiff
path: root/shared-bindings
diff options
context:
space:
mode:
authorScott Shawcroft <scott@adafruit.com>2020-07-13 16:29:58 -0700
committerGitHub <noreply@github.com>2020-07-13 16:29:58 -0700
commit08375c79307c456759bb8cf83aeb96751901d8b0 (patch)
tree2292c5826c012c243d0841ef2841fdc6777dcf23 /shared-bindings
parent51c888d4be5ec0e0bc19a0de539f0f21a04da135 (diff)
parent70fdde4aaaa6c1c8fd54c0463d405dfbf8794b10 (diff)
Merge pull request #2780 from AndrewR-L/patch-1
busio/UART: Correct and clarify readline() return.
Diffstat (limited to 'shared-bindings')
-rw-r--r--shared-bindings/busio/UART.c7
-rw-r--r--shared-bindings/time/__init__.c2
2 files changed, 5 insertions, 4 deletions
diff --git a/shared-bindings/busio/UART.c b/shared-bindings/busio/UART.c
index 018ded182..a9619a8e0 100644
--- a/shared-bindings/busio/UART.c
+++ b/shared-bindings/busio/UART.c
@@ -199,12 +199,13 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(busio_uart___exit___obj, 4, 4, busio_
//| *New in CircuitPython 4.0:* No length parameter is permitted."""
//| ...
//|
-
//| def readline(self, ) -> Any:
-//| """Read a line, ending in a newline character.
+//| """Read a line, ending in a newline character, or
+//| return None if a timeout occurs sooner, or
+//| return everything readable if no newline is found and timeout=0
//|
//| :return: the line read
-//| :rtype: int or None"""
+//| :rtype: bytes or None"""
//| ...
//|
diff --git a/shared-bindings/time/__init__.c b/shared-bindings/time/__init__.c
index 2f8a1c3e2..ae978a497 100644
--- a/shared-bindings/time/__init__.c
+++ b/shared-bindings/time/__init__.c
@@ -102,7 +102,7 @@ mp_obj_t struct_time_make_new(const mp_obj_type_t *type, size_t n_args, const mp
//| * ``tm_month``: the month, range [1, 12]
//| * ``tm_mday``: the day of the month, range [1, 31]
//| * ``tm_hour``: the hour, range [0, 23]
-//| * ``tm_minute``: the minute, range [0, 59]
+//| * ``tm_min``: the minute, range [0, 59]
//| * ``tm_sec``: the second, range [0, 61]
//| * ``tm_wday``: the day of the week, range [0, 6], Monday is 0
//| * ``tm_yday``: the day of the year, range [1, 366], -1 indicates not known