From 622122cdefd7bd32a1647d24e3f637bbc555ae8f Mon Sep 17 00:00:00 2001 From: Marc Beninca Date: Tue, 17 Sep 2024 12:53:17 +0200 Subject: [PATCH 1/3] doc/prj --- rwx/prj/__init__.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/rwx/prj/__init__.py b/rwx/prj/__init__.py index c0251e2..cfbe3ae 100644 --- a/rwx/prj/__init__.py +++ b/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 From d6e112d6c50115faa4d54c6c21fd6aa26541ce46 Mon Sep 17 00:00:00 2001 From: Marc Beninca Date: Tue, 17 Sep 2024 12:54:41 +0200 Subject: [PATCH 2/3] doc/debian --- rwx/os/debian.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/rwx/os/debian.py b/rwx/os/debian.py index 98c8928..5cefdaa 100644 --- a/rwx/os/debian.py +++ b/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" From 012b10f7d56d12b7125798cbed00e7f28b8ef61f Mon Sep 17 00:00:00 2001 From: Marc Beninca Date: Tue, 17 Sep 2024 14:53:21 +0200 Subject: [PATCH 3/3] 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),