Skip to content

Commit 62d944a

Browse files
Merge pull request #24 from EGJ-Moorington/23-fix-typos-in-documentation
Fixed some typos and slightly improved the docstrings for the documentation. Closes #23
2 parents 5016c13 + c5bb7cf commit 62d944a

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

button_handler.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ def __init__(
102102
:value: max_multi_press = 2
103103
104104
The maximum amount of button presses that a multi-press can be.
105-
:meth:`ButtonHandler.update` returns the appropiate multi-press :class:`ButtonInput`
105+
:meth:`ButtonHandler.update` returns the appropriate multi-press :class:`ButtonInput`
106106
object immediaetly after the button has been pressed this many times.
107107
108108
.. attribute:: multi_press_interval
@@ -153,7 +153,7 @@ def __init__(
153153
:value: config.max_multi_press = 2
154154
155155
The maximum amount of button presses that a multi-press can be.
156-
:meth:`ButtonHandler.update` returns the appropiate multi-press :class:`ButtonInput`
156+
:meth:`ButtonHandler.update` returns the appropriate multi-press :class:`ButtonInput`
157157
object immediaetly after the button has been pressed this many times.
158158
159159
.. attribute:: multi_press_interval
@@ -333,20 +333,20 @@ def __init__(
333333
334334
.. attribute:: button_number
335335
:type: int
336-
:value: button_number = 0
336+
:value: 0
337337
338338
The index number of the button associated with the input.
339339
340340
.. attribute:: callback
341341
:type: Callable[[], None]
342-
:value: callback = lambda: None
342+
:value: lambda: None
343343
344344
The function to call when the input is detected
345-
and returned by :meth:`ButtonHandler.update`
345+
and returned by :meth:`ButtonHandler.update`.
346346
347347
.. attribute:: timestamp
348348
:type: int
349-
:value: timestamp = 0
349+
:value: 0
350350
351351
The timestamp (in milliseconds, provided by :meth:`supervisor.ticks_ms`)
352352
at which the input was performed.
@@ -450,7 +450,7 @@ def __hash__(self) -> int:
450450
:return: The hash value of the input.
451451
:rtype: int
452452
453-
.. seealso:: :meth:`__eq__` - two :class:`ButtonInput` objects hash to the same value
453+
.. seealso:: :meth:`__eq__` two :class:`ButtonInput` objects hash to the same value
454454
if they are equal.
455455
"""
456456
return hash((self.action, self.button_number))

0 commit comments

Comments
 (0)