Skip to content

Commit 3bb117d

Browse files
committed
update class DOC strings
1 parent 6044f2c commit 3bb117d

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

adafruit_usb_host_mouse/__init__.py

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ class BootMouse:
225225
:param device: The usb device instance for the mouse
226226
:param interface_index: The USB interface index of the mouse
227227
:param endpoint_address: The address of the mouse endpoint
228-
:param was_attached: Whether the usb device was attached to the kernel
228+
:param was_attached: A list of the usb devices detached from the kernel.
229229
:param tilegrid: The TileGrid that holds the visible mouse cursor
230230
:param scale: The scale of the group that the Mouse TileGrid will be put into.
231231
Needed in order to properly clamp the mouse to the display bounds
@@ -359,6 +359,20 @@ def update(self):
359359

360360

361361
class ReportMouse(BootMouse):
362+
"""
363+
Helpler class that encapsulates the objects needed to interact with a non-Boot
364+
mouse (Report), show a visible cursor on the display, and determine when buttons
365+
were pressed. The class is a subclass of BootMouse that overrides the update method.
366+
367+
:param device: The usb device instance for the mouse
368+
:param interface_index: The USB interface index of the mouse
369+
:param endpoint_address: The address of the mouse endpoint
370+
:param was_attached: A list of the usb devices detached from the kernel.
371+
:param tilegrid: The TileGrid that holds the visible mouse cursor
372+
:param scale: The scale of the group that the Mouse TileGrid will be put into.
373+
Needed in order to properly clamp the mouse to the display bounds
374+
"""
375+
362376
def __init__( # noqa: PLR0913, too many args
363377
self, device, interface_index, endpoint_address, was_attached, *, tilegrid=None, scale=1
364378
):

0 commit comments

Comments
 (0)