Skip to content

Commit fa94bf3

Browse files
committed
Update docstring
1 parent 0085dbd commit fa94bf3

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

adafruit_usb_host_mouse.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,8 +174,9 @@ def update(self):
174174
Read data from the USB mouse and update the location of the visible cursor
175175
and check if any buttons are pressed.
176176
177-
:return: a List containing one or more of the strings "left", "right", "middle"
178-
indicating which buttons are pressed.
177+
:return: a tuple containing one or more of the strings "left", "right", "middle"
178+
indicating which buttons are pressed. If no buttons are pressed, the tuple will be empty.
179+
If a error occurred while trying to read from the usb device, `None` will be returned.
179180
"""
180181
try:
181182
# attempt to read data from the mouse

0 commit comments

Comments
 (0)