yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Docs: improve api docs of {open_file, open_clan_folder}

Browse Source
This commit is contained in:
Johannes Kirschbauer
2025-07-10 18:40:48 +02:00
parent 387807800e
commit 7f3292ceb0
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
pkgs/clan-cli/clan_lib/api/directory.py
View File

@@ -32,8 +32,10 @@ class FileRequest:
@API.register_abstract @API.register_abstract
def open_file(file_request: FileRequest) -> list[str] | None: def open_file(file_request: FileRequest) -> list[str] | None:
""" """
Abstract api method to open a file dialog window. Api method to open a file dialog window.
It must return the name of the selected file or None if no file was selected.
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" msg = "open_file() is not implemented"
raise NotImplementedError(msg) raise NotImplementedError(msg)
@@ -42,8 +44,9 @@ def open_file(file_request: FileRequest) -> list[str] | None:
@API.register_abstract @API.register_abstract
def open_clan_folder() -> Flake: def open_clan_folder() -> Flake:
""" """
Abstract api method to open the clan folder. Api method to open the clan folder.
It must return the path to the clan folder.
Implementations is specific to the platform and returns the path to the clan folder.
""" """
msg = "open_clan_folder() is not implemented" msg = "open_clan_folder() is not implemented"
raise NotImplementedError(msg) raise NotImplementedError(msg)