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

Author: EGJ-Moorington

.pre-commit-config.yaml

@@ -4,18 +4,18 @@
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.4
+    rev: v0.11.13
     hooks:
       - id: ruff-format
       - id: ruff
         args: ["--fix"]
   - repo: https://github.com/fsfe/reuse-tool
-    rev: v3.0.1
+    rev: v5.0.2
     hooks:
       - id: reuse

button_handler.py

@@ -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
@@ -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
@@ -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.
@@ -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))

docs/conf.py

@@ -114,7 +114,7 @@
 import sphinx_rtd_theme
 
 html_theme = "sphinx_rtd_theme"
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
+# html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

ruff.toml

@@ -16,7 +16,7 @@ extend-select = [
   "PLC2401",  # non-ascii-name
   "PLC2801",  # unnecessary-dunder-call
   "PLC3002",  # unnecessary-direct-lambda-call
-  "E999",  # syntax-error
+# "E999",  # syntax-error
   "PLE0101",  # return-in-init
   "F706",  # return-outside-function
   "F704",  # yield-outside-function