djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

shared-bindings/usb_hid: Fix docs for Device.get_last_received_report()

Browse Source 
Update documentation for Device.get_last_received_report() fixing
type signature and adding note on "consume" behavior.
This commit is contained in:
Maxim Kulkin 2022-08-24 17:59:09 -04:00
parent b481411541
commit 76ce46a530
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
shared-bindings/usb_hid/Device.c
View File

@ -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.
//| """
//| ...
//|