From 508cd3c784fa61c2af1f1bab97c296fba0adc25e Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Mon, 7 Jul 2025 15:31:06 +0200 Subject: [PATCH] docs/api: add docstrings to {get_clan_details} --- pkgs/clan-cli/clan_lib/clan/get.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/pkgs/clan-cli/clan_lib/clan/get.py b/pkgs/clan-cli/clan_lib/clan/get.py index 5fb43f31d..3127c80bd 100644 --- a/pkgs/clan-cli/clan_lib/clan/get.py +++ b/pkgs/clan-cli/clan_lib/clan/get.py @@ -7,6 +7,14 @@ from clan_lib.persist.inventory_store import InventoryStore @API.register def get_clan_details(flake: Flake) -> InventoryMeta: + """Retrieve the clan details from the inventory of a given flake. + Args: + flake: The Flake instance representing the clan. + Returns: + InventoryMeta: The meta information from the clan's inventory. + Raises: + ClanError: If the flake does not exist, or if the inventory is invalid (missing the meta attribute). + """ if flake.is_local and not flake.path.exists(): msg = f"Path {flake} does not exist" raise ClanError(msg, description="clan directory does not exist")