Fix pre-commit checks

Author: mwydmuch

.github/workflows/pre-commit.yml

@@ -4,7 +4,7 @@ name: Pre-commit
 on:
   pull_request:
   push:
-    branches: [main]
+    branches: [master]
 
 permissions:
   contents: read # to fetch code (actions/checkout)

docs/api_cpp/utils.md

@@ -65,8 +65,8 @@ Calculates the number of seconds that will pass during specified number of tics.
 | Python | `doom_fixed_to_double(doomFixed: int | float) -> float` |
 
 Converts fixed point numeral to a floating point value.
-Doom's engine internaly use fixed point numbers. 
-If you read them directly from `USERX` variables, 
+Doom's engine internally use fixed point numbers.
+If you read them directly from `USERX` variables,
 you may want to convert them to floating point numbers.
 
 See also:

scripts/create_python_docs_from_cpp_docs.py

@@ -4,13 +4,21 @@
 
 
 FILES_TO_PARSE = [
-    {"input_filepath": "docs/api_cpp/doomGame.md", "output_filepath": "docs/api_python/doomGame.md", "submodule": "DoomGame.", 
-     "append_to_header": """
+    {
+        "input_filepath": "docs/api_cpp/doomGame.md",
+        "output_filepath": "docs/api_python/doomGame.md",
+        "submodule": "DoomGame.",
+        "append_to_header": """
 ```{eval-rst}
 .. autoclass:: vizdoom.DoomGame
 ```
-"""},
-    {"input_filepath": "docs/api_cpp/utils.md", "output_filepath": "docs/api_python/utils.md", "submodule": ""},
+""",
+    },
+    {
+        "input_filepath": "docs/api_cpp/utils.md",
+        "output_filepath": "docs/api_python/utils.md",
+        "submodule": "",
+    },
 ]
 SECTION_REGEX = r"^##+ *([a-zA-Z ]+) *$"
 FUNCTION_REGEX = r"^###+ *`([a-zA-Z]+)` *$"
@@ -43,13 +51,15 @@
 
                 elif not started:
                     start_lines += line
-                
+
                 else:
                     match = re.match(FUNCTION_REGEX, line)
                     if match:
                         function_name = match.group(1)
                         function_name = function_name.replace("ViZDoom", "Vizdoom")
-                        function_name = re.sub(r'(?<!^)(?=[A-Z])', '_', function_name).lower()  # Convert CamelCase to snake_case
-                        output_file.write(f".. autofunction:: vizdoom.{fp['submodule']}{function_name}\n")
-
-
+                        function_name = re.sub(
+                            r"(?<!^)(?=[A-Z])", "_", function_name
+                        ).lower()  # Convert CamelCase to snake_case
+                        output_file.write(
+                            f".. autofunction:: vizdoom.{fp['submodule']}{function_name}\n"
+                        )

scripts/create_python_docstrings_from_cpp_docs.py

@@ -11,7 +11,7 @@
 RAW_STRING_ESCAPE_SEQ = "DOCSTRING"
 FUNCTION_HEADER_REGEX = r"^##+ *`([a-zA-Z]+)` *$"
 TO_REPLACE = [
-    r"\[([`a-zA-Z]+)\]\(.*\)", # Links
+    r"\[([`a-zA-Z]+)\]\(.*\)",  # Links
 ]
 LINES_TO_IGNORE_REGEXES = [
     r"---",  # Lines
@@ -24,7 +24,7 @@
     r"^Deprecated since .*$",  # Deprecated since annotations
     r"^Removed in .*$",  # Removed in annotations
     r"^Config key: .*$",  # Config annotations
-    r"^Python aliases .*$",  # Python aliasses
+    r"^Python aliases .*$",  # Python aliases
     r"^#+.*",  # Other headings
 ]
 
@@ -80,7 +80,9 @@
                         next_docstring += line
 
             if started:
-                output_file.write(f'{next_docstring.strip()}){RAW_STRING_ESCAPE_SEQ}";\n\n')
+                output_file.write(
+                    f'{next_docstring.strip()}){RAW_STRING_ESCAPE_SEQ}";\n\n'
+                )
 
             if "namespace" in file:
                 output_file.write(f"}} // namespace {file['namespace']}\n\n")