Skip to content

Fixed some typos in docstrings #24

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
merged 1 commit into from
Jun 17, 2025
Merged

Fixed some typos in docstrings #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions button_handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ def __init__(
:value: max_multi_press = 2

The maximum amount of button presses that a multi-press can be.
:meth:`ButtonHandler.update` returns the appropiate multi-press :class:`ButtonInput`
:meth:`ButtonHandler.update` returns the appropriate multi-press :class:`ButtonInput`
object immediaetly after the button has been pressed this many times.

.. attribute:: multi_press_interval
Expand Down Expand Up @@ -153,7 +153,7 @@ def __init__(
:value: config.max_multi_press = 2

The maximum amount of button presses that a multi-press can be.
:meth:`ButtonHandler.update` returns the appropiate multi-press :class:`ButtonInput`
:meth:`ButtonHandler.update` returns the appropriate multi-press :class:`ButtonInput`
object immediaetly after the button has been pressed this many times.

.. attribute:: multi_press_interval
Expand Down Expand Up @@ -333,20 +333,20 @@ def __init__(

.. attribute:: button_number
:type: int
:value: button_number = 0
:value: 0

The index number of the button associated with the input.

.. attribute:: callback
:type: Callable[[], None]
:value: callback = lambda: None
:value: lambda: None

The function to call when the input is detected
and returned by :meth:`ButtonHandler.update`
and returned by :meth:`ButtonHandler.update`.

.. attribute:: timestamp
:type: int
:value: timestamp = 0
:value: 0

The timestamp (in milliseconds, provided by :meth:`supervisor.ticks_ms`)
at which the input was performed.
Expand Down Expand Up @@ -450,7 +450,7 @@ def __hash__(self) -> int:
:return: The hash value of the input.
:rtype: int

.. seealso:: :meth:`__eq__` - two :class:`ButtonInput` objects hash to the same value
.. seealso:: :meth:`__eq__` — two :class:`ButtonInput` objects hash to the same value
if they are equal.
"""
return hash((self.action, self.button_number))
Expand Down
Loading