docs: improve docstring for 'list_block_devices'

2025-07-07 10:46:26 +02:00
parent 0e10122d54
commit 84703fa293
1 changed files with 3 additions and 2 deletions
--- a/pkgs/clan-cli/clan_lib/api/directory.py
+++ b/pkgs/clan-cli/clan_lib/api/directory.py
@@ -124,9 +124,10 @@ def blk_from_dict(data: dict) -> BlkInfo:
@API.register
 def list_block_devices() -> Blockdevices:
    """
-    Api method to show local block devices.
+    List local block devices by running `lsblk`.

-    It must return a list of block devices.
+    Returns:
+        A list of detected block devices with metadata like size, path, type, etc.
    """

    cmd = nix_shell(