doc/frame,shut,step

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)