From 012b10f7d56d12b7125798cbed00e7f28b8ef61f Mon Sep 17 00:00:00 2001
From: Marc Beninca <git@marc.beninca.link>
Date: Tue, 17 Sep 2024 14:53:21 +0200
Subject: [PATCH] doc/grub

---
 rwx/grub/__init__.py | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/rwx/grub/__init__.py b/rwx/grub/__init__.py
index 7c0cccc..572b13e 100644
--- a/rwx/grub/__init__.py
+++ b/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),