Skip to content

Minor documentation typo fixes #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tekktrik merged 2 commits into from
Mar 18, 2026
Merged

Minor documentation typo fixes #16

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22a79bc
Fix return docstring typos
relic-se Feb 8, 2026
91f2805
Fix typos in class docstrings
relic-se Feb 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions adafruit_usb_host_mouse/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ def find_and_init_mouse(cursor_image=DEFAULT_CURSOR, subclass=SUBCLASS_BOOT):
:param subclass: Defines whether to search for boot or non-boot mice.
SUBCLASS_BOOT (0X01), a boot mouse will be searched for
SUBCLASS_RESERVED (0x00), a non-boot (report) mouse will be searched for
:return: A tupple cotaining the arguments needed by the calling find and init helper
:return: A tuple containing the arguments needed by the calling find and init helper
function. If no mouse is found None is returned.
"""
mouse_interface_index, mouse_endpoint_address = None, None
Expand Down Expand Up @@ -177,7 +177,7 @@ def find_and_init_report_mouse(cursor_image=DEFAULT_CURSOR, scale=1):

class BootMouse:
"""
Helpler class that encapsulates the objects needed to interact with a boot
Helper class that encapsulates the objects needed to interact with a boot
mouse, show a visible cursor on the display, and determine when buttons
were pressed.

Expand Down Expand Up @@ -318,7 +318,7 @@ def update(self):

class ReportMouse(BootMouse):
"""
Helpler class that encapsulates the objects needed to interact with a non-Boot
Helper class that encapsulates the objects needed to interact with a non-Boot
mouse (Report), show a visible cursor on the display, and determine when buttons
were pressed. The class is a subclass of BootMouse that overrides the update method.

Expand Down