From c503f41b7c10cb4bdeb51cf1438b15d3154b5c47 Mon Sep 17 00:00:00 2001
From: Johannes Kirschbauer <hsjobeki@gmail.com>
Date: Mon, 7 Jul 2025 10:46:26 +0200
Subject: [PATCH] docs: improve docstring for 'list_block_devices'

---
 pkgs/clan-cli/clan_lib/api/directory.py | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/pkgs/clan-cli/clan_lib/api/directory.py b/pkgs/clan-cli/clan_lib/api/directory.py
index af533eaeb..a0cbcb0e9 100644
--- 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(