Skip to content

Commit 5f71daf

Browse files
authored
Merge pull request #131 from dhalbert/missing-doc
Add inadvertently omitted __init__.py docs, and fix indentation
2 parents e9eb435 + ed85927 commit 5f71daf

File tree

2 files changed

+8
-9
lines changed

2 files changed

+8
-9
lines changed

adafruit_hid/__init__.py

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,6 @@
99
This driver simulates USB HID devices.
1010
1111
* Author(s): Scott Shawcroft, Dan Halbert
12-
13-
Implementation Notes
14-
--------------------
15-
**Software and Dependencies:**
16-
* Adafruit CircuitPython firmware for the supported boards:
17-
https://github.com/adafruit/circuitpython/releases
1812
"""
1913

2014
# imports
@@ -48,12 +42,14 @@ def find_device(
4842
usage: int,
4943
timeout: int = None,
5044
) -> object:
51-
"""Search through the provided sequence of devices to find the one with the matching
45+
"""
46+
Search through the provided sequence of devices to find the one with the matching
5247
usage_page and usage.
5348
5449
:param timeout: Time in seconds to wait for USB to become ready before timing out.
55-
Defaults to None to wait indefinitely.
56-
Ignored if device is not a `usb_hid.Device`; it might be BLE, for instance."""
50+
Defaults to None to wait indefinitely.
51+
Ignored if device is not a `usb_hid.Device`; it might be BLE, for instance.
52+
"""
5753

5854
if hasattr(devices, "send_report"):
5955
devices = [devices] # type: ignore

docs/api.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11

22
.. If you created a package, create one automodule per module in the package.
33
4+
.. automodule:: adafruit_hid
5+
:members:
6+
47
.. automodule:: adafruit_hid.keyboard
58
:members:
69

0 commit comments

Comments
 (0)