From ba8c9baa5413b844f131bd38a8562e5859e44d90 Mon Sep 17 00:00:00 2001 From: Marc Beninca Date: Mon, 16 Sep 2024 01:03:41 +0200 Subject: [PATCH] doc/frame,shut,step --- spcd/util.py | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/spcd/util.py b/spcd/util.py index 66fd269..8dda359 100644 --- a/spcd/util.py +++ b/spcd/util.py @@ -42,12 +42,20 @@ def cat(file: Path) -> None: def frame(text: str) -> None: - """Open a new frame in the log output.""" + """Open a new frame in the log output. + + :param text: text to start the frame with + :type text: str + """ log.info("%s%s", env.SPCD_OPEN, text) def shut(text: str) -> None: - """Close current frame in the log output.""" + """Close current frame in the log output. + + :param text: text to shut the frame with + :type text: str + """ log.info("%s%s", env.SPCD_SHUT, text) @@ -57,7 +65,11 @@ def split() -> None: def step(text: str) -> None: - """Increment the step number of the current build process.""" + """Increment the step number of the current build process. + + :param text: text to display + :type text: str + """ shell.STEP += 1 log.info(env.SPCD_DOWN) log.info("%s %s %s", env.SPCD_VERT, shell.STEP, text)