From 40bb13c39af534c0cf58084315465b7b68b5fe8f Mon Sep 17 00:00:00 2001 From: Marc Beninca Date: Mon, 16 Sep 2024 01:08:25 +0200 Subject: [PATCH] doc/browse,cat --- spcd/util.py | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/spcd/util.py b/spcd/util.py index 8dda359..2f8a7ab 100644 --- a/spcd/util.py +++ b/spcd/util.py @@ -19,7 +19,11 @@ def add_url_path(url: str, extra_path: str) -> str: def browse(root: Path) -> None: - """Frame the browsing of a root directory in the log output.""" + """Frame the browsing of a root directory in the log output. + + :param root: directory to browse + :type root: Path + """ paths = [] for directory, _, files in os.walk(root): for file in files: @@ -34,7 +38,11 @@ def browse(root: Path) -> None: def cat(file: Path) -> None: - """Frame the content of a file in the log output.""" + """Frame the content of a file in the log output. + + :param file: file to read the content from + :type file: Path + """ text = str(file) frame(text) log.info(fs.read_file_text(file).rstrip())