shared-bindings: Update docs to remove with statements from examples but add more detail to the design guide about their use.

2 files changed, 9 insertions, 13 deletions

diff --git a/shared-bindings/usb_hid/Device.c b/shared-bindings/usb_hid/Device.c
index 3a3cc5170..7e5d3d9e8 100644
--- a/shared-bindings/usb_hid/Device.c
+++ b/shared-bindings/usb_hid/Device.c
@@ -55,13 +55,13 @@ STATIC mp_obj_t usb_hid_device_make_new(const mp_obj_type_t *type,
 //|     Send a HID report.
 //|
 STATIC mp_obj_t usb_hid_device_send_report(mp_obj_t self_in, mp_obj_t buffer) {
-   usb_hid_device_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    usb_hid_device_obj_t *self = MP_OBJ_TO_PTR(self_in);
 
-   mp_buffer_info_t bufinfo;
-   mp_get_buffer_raise(buffer, &bufinfo, MP_BUFFER_READ);
+    mp_buffer_info_t bufinfo;
+    mp_get_buffer_raise(buffer, &bufinfo, MP_BUFFER_READ);
 
-   common_hal_usb_hid_device_send_report(self, ((uint8_t*) bufinfo.buf), bufinfo.len);
-   return mp_const_none;
+    common_hal_usb_hid_device_send_report(self, ((uint8_t*) bufinfo.buf), bufinfo.len);
+    return mp_const_none;
 }
 MP_DEFINE_CONST_FUN_OBJ_2(usb_hid_device_send_report_obj, usb_hid_device_send_report);
 
@@ -73,8 +73,8 @@ MP_DEFINE_CONST_FUN_OBJ_2(usb_hid_device_send_report_obj, usb_hid_device_send_re
 //|     :rtype: int
 //|
 STATIC mp_obj_t usb_hid_device_obj_get_usage_page(mp_obj_t self_in) {
-   usb_hid_device_obj_t *self = MP_OBJ_TO_PTR(self_in);
-   return MP_OBJ_NEW_SMALL_INT(common_hal_usb_hid_device_get_usage_page(self));
+    usb_hid_device_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    return MP_OBJ_NEW_SMALL_INT(common_hal_usb_hid_device_get_usage_page(self));
 }
 MP_DEFINE_CONST_FUN_OBJ_1(usb_hid_device_get_usage_page_obj, usb_hid_device_obj_get_usage_page);
 
@@ -95,8 +95,8 @@ const mp_obj_property_t usb_hid_device_usage_page_obj = {
 //|     :rtype: int
 //|
 STATIC mp_obj_t usb_hid_device_obj_get_usage(mp_obj_t self_in) {
-   usb_hid_device_obj_t *self = MP_OBJ_TO_PTR(self_in);
-   return MP_OBJ_NEW_SMALL_INT(common_hal_usb_hid_device_get_usage(self));
+    usb_hid_device_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    return MP_OBJ_NEW_SMALL_INT(common_hal_usb_hid_device_get_usage(self));
 }
 MP_DEFINE_CONST_FUN_OBJ_1(usb_hid_device_get_usage_obj,
                           usb_hid_device_obj_get_usage);
diff --git a/shared-bindings/usb_hid/__init__.c b/shared-bindings/usb_hid/__init__.c
index a870cb4a1..3ad5b06e0 100644
--- a/shared-bindings/usb_hid/__init__.c
+++ b/shared-bindings/usb_hid/__init__.c
@@ -41,10 +41,6 @@
 //| The `usb_hid` module allows you to output data as a HID device.
 //|
 
-//| .. warning:: This module may be dropped from builds without external flash
-//|   in the future. Please file an issue if this a problem and explain why.
-//|
-
 //| .. attribute:: usb_hid.devices
 //|
 //|   Tuple of all active HID device interfaces.