From 7f3292ceb0a54a9e6c7d9e54debdb5a9be7e1b9a Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Thu, 10 Jul 2025 18:40:48 +0200 Subject: [PATCH] Docs: improve api docs of {open_file, open_clan_folder} --- pkgs/clan-cli/clan_lib/api/directory.py | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/pkgs/clan-cli/clan_lib/api/directory.py b/pkgs/clan-cli/clan_lib/api/directory.py index bcbbb57af..ea2f6c5bf 100644 --- a/pkgs/clan-cli/clan_lib/api/directory.py +++ b/pkgs/clan-cli/clan_lib/api/directory.py @@ -32,8 +32,10 @@ class FileRequest: @API.register_abstract def open_file(file_request: FileRequest) -> list[str] | None: """ - Abstract api method to open a file dialog window. - It must return the name of the selected file or None if no file was selected. + Api method to open a file dialog window. + + Implementations is specific to the platform and + returns the name of the selected file or None if no file was selected. """ msg = "open_file() is not implemented" raise NotImplementedError(msg) @@ -42,8 +44,9 @@ def open_file(file_request: FileRequest) -> list[str] | None: @API.register_abstract def open_clan_folder() -> Flake: """ - Abstract api method to open the clan folder. - It must return the path to the clan folder. + Api method to open the clan folder. + + Implementations is specific to the platform and returns the path to the clan folder. """ msg = "open_clan_folder() is not implemented" raise NotImplementedError(msg)