docstring/cmd

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