chore: lint and format

hooks/gen_docs/gen_docs_changelog.py

@@ -1,6 +1,6 @@
 """Copies ``CHANGELOG.md`` from root to the docs."""
-from hooks.gen_docs.utils import copy_file
 from hooks import ROOT
+from hooks.gen_docs.utils import copy_file
 
 SOURCE = ROOT / "CHANGELOG.md"
 DEST = ROOT / "docs/docs/user/changelog.md"

hooks/gen_docs/utils.py

@@ -1,16 +1,24 @@
+import inspect
 import shutil
 from pathlib import Path
 from tempfile import TemporaryFile
+
 from hooks import ROOT
-import inspect
 
-def copy_file(source: Path, dest: Path, *, add_header: bool | None = None, header: str | None = None) -> None:
-    """Copy file from 1 location to another, optionally add a header
+
+def copy_file(
+    source: Path,
+    dest: Path,
+    *,
+    add_header: bool | None = None,
+    header: str | None = None,
+) -> None:
+    r"""Copy file from 1 location to another, optionally add a header.
 
     :param source: Path to file to be copied
     :param dest: Path to new file
-    :param add_header: Whether to add header 
-    :param header: Will be placed at the top of the file, defaults to 
+    :param add_header: Whether to add header
+    :param header: Will be placed at the top of the file, defaults to
         ``f"<!-- This file is autogenerated by {Path(__file__).relative_to(ROOT)}. -->\n\n"``
         NOTE: The default header will only contain correct information if the caller of
         this function is the one which should be referenced in the header