From b41478a7474de2f8ef17e52aede23aabe6eb9d9a Mon Sep 17 00:00:00 2001 From: Marc Beninca Date: Mon, 19 Aug 2024 17:44:07 +0200 Subject: [PATCH] docstring/cmd --- spcd/cmd.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/spcd/cmd.py b/spcd/cmd.py index 1cd4e7f..a1108ee 100644 --- a/spcd/cmd.py +++ b/spcd/cmd.py @@ -11,10 +11,12 @@ from spcd.util import browse def spcd_browse_workspace() -> None: + """Browse the current workspace for the project.""" browse(project.root) def spcd_build_project() -> None: + """Perform the actual building process.""" for extension in ["py", "sh"]: path = Path(project.root) / f"build.{extension}" if path.exists(): @@ -25,12 +27,14 @@ def spcd_build_project() -> None: def spcd_check_project() -> None: + """Check the project for anything wrong.""" ps.run("ruff", "check") def spcd_synchronize( target: str | None = None, source: str | None = None ) -> None: + """Synchronize output towards a target.""" if not target: user = "cd" host = env.SPCD_PROJECT_PATH