From ed85927c1c9c8f9ba2247d6a37a72594eb1b7b85 Mon Sep 17 00:00:00 2001 From: Dan Halbert Date: Wed, 18 Dec 2024 13:31:33 -0500 Subject: [PATCH] Add inadvertently omitted __init__.py docs, and fix indentation --- adafruit_hid/__init__.py | 14 +++++--------- docs/api.rst | 3 +++ 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/adafruit_hid/__init__.py b/adafruit_hid/__init__.py index 06c220d..96c7d60 100644 --- a/adafruit_hid/__init__.py +++ b/adafruit_hid/__init__.py @@ -9,12 +9,6 @@ This driver simulates USB HID devices. * Author(s): Scott Shawcroft, Dan Halbert - -Implementation Notes --------------------- -**Software and Dependencies:** -* Adafruit CircuitPython firmware for the supported boards: - https://github.com/adafruit/circuitpython/releases """ # imports @@ -48,12 +42,14 @@ def find_device( usage: int, timeout: int = None, ) -> object: - """Search through the provided sequence of devices to find the one with the matching + """ + Search through the provided sequence of devices to find the one with the matching usage_page and usage. :param timeout: Time in seconds to wait for USB to become ready before timing out. - Defaults to None to wait indefinitely. - Ignored if device is not a `usb_hid.Device`; it might be BLE, for instance.""" + Defaults to None to wait indefinitely. + Ignored if device is not a `usb_hid.Device`; it might be BLE, for instance. + """ if hasattr(devices, "send_report"): devices = [devices] # type: ignore diff --git a/docs/api.rst b/docs/api.rst index 8094867..51f9a9b 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,6 +1,9 @@ .. If you created a package, create one automodule per module in the package. +.. automodule:: adafruit_hid + :members: + .. automodule:: adafruit_hid.keyboard :members: