From 76ce46a530c708212e1fbe9cbfbf6e20bfae1bc5 Mon Sep 17 00:00:00 2001 From: Maxim Kulkin Date: Wed, 24 Aug 2022 17:59:09 -0400 Subject: [PATCH] shared-bindings/usb_hid: Fix docs for Device.get_last_received_report() Update documentation for Device.get_last_received_report() fixing type signature and adding note on "consume" behavior. --- shared-bindings/usb_hid/Device.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/shared-bindings/usb_hid/Device.c b/shared-bindings/usb_hid/Device.c index f0074f9cac..fbb78a482e 100644 --- a/shared-bindings/usb_hid/Device.c +++ b/shared-bindings/usb_hid/Device.c @@ -191,10 +191,11 @@ STATIC mp_obj_t usb_hid_device_send_report(size_t n_args, const mp_obj_t *pos_ar } MP_DEFINE_CONST_FUN_OBJ_KW(usb_hid_device_send_report_obj, 1, usb_hid_device_send_report); -//| def get_last_received_report(self, report_id: Optional[int] = None) -> bytes: +//| def get_last_received_report(self, report_id: Optional[int] = None) -> Optional[bytes]: //| """Get the last received HID OUT or feature report for the given report ID. //| The report ID may be omitted if there is no report ID, or only one report ID. -//| Return `None` if nothing received. +//| Return `None` if nothing received. After returning a report, subsequent calls +//| will return `None` until next report is received. //| """ //| ... //|