Skip to content

Commit

Permalink
Merge pull request #131 from dhalbert/missing-doc
Browse files Browse the repository at this point in the history
Add inadvertently omitted __init__.py docs, and fix indentation
  • Loading branch information
tannewt authored Dec 19, 2024
2 parents e9eb435 + ed85927 commit 5f71daf
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
14 changes: 5 additions & 9 deletions adafruit_hid/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -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:

Expand Down

0 comments on commit 5f71daf

Please sign in to comment.