doc/grub

rwx/grub/__init__.py

@@ -24,7 +24,19 @@ def make_image(
     memdisk_path: str,
     pubkey_path: str | None = None,
 ) -> None:
-    """Make a binary bootable image."""
+    """Make a binary bootable image.
+
+    :param image_format: output format (x86_64-efi, i386-pc, arm64-efi)
+    :type image_format: str
+    :param image_path: output file
+    :type image_path: str
+    :param modules: modules to embed
+    :type modules: list[str]
+    :param memdisk_path: archive to include
+    :type memdisk_path: str
+    :param pubkey_path: extra public key to add
+    :type pubkey_path: str | None
+    """
     args: list[str | tuple[str, ...]] = [
         "grub-mkimage",
         ("--compress", COMPRESSION),

rwx/os/debian.py

@@ -7,5 +7,8 @@ class Debian(OS):
     """Debian operating system."""
 
     def get_name(self) -> str:
-        """Return name."""
+        """Return name.
+
+        :rtype: str
+        """
         return "Debian"

rwx/prj/__init__.py

@@ -9,7 +9,11 @@ class Project(Class):
     """Parent class for any type of project."""
 
     def __init__(self, file: Path) -> None:
-        """Set file, root & name."""
+        """Set file, root & name.
+
+        :param file: root reference file
+        :type file: Path
+        """
         self.raw = file
         self.file = self.raw.resolve()
         self.root: Path = self.file.parent