doc/main

spcd/__init__.py

@@ -44,7 +44,7 @@ def clone_project_branch() -> None:
         )
 
 
-def install_commands(path: str) -> None:
+def install_commands(path: Path) -> None:
     """Make commands callable in the operating system."""
     step("Install commands")
     user = Path("/usr/local/bin")
@@ -92,8 +92,12 @@ def list_environment_variables() -> None:
             log.info("%s", variable)
 
 
-def main(main_file: str) -> None:
-    """Entry point to initialize environment or run a specific command."""
+def main(main_file: Path) -> None:
+    """Entry point to initialize environment or run a specific command.
+
+    :param main_file: entry point file calling this function
+    :type main_file: Path
+    """
     paths = environ["PATH"].split(pathsep)
     if env.SPCD_PYTHON_VENV_BINARIES not in paths:
         environ["PATH"] = pathsep.join([env.SPCD_PYTHON_VENV_BINARIES, *paths])