docstrings

Author: TezRomacH

hooks/post_gen_project.py

@@ -27,13 +27,24 @@
 
 
 def generate_license(directory: Path, licence: str) -> None:
-    """Generate license file for the project."""
+    """Generate license file for the project.
+
+    Args:
+        directory: path to the project directory
+        licence: chosen licence
+    """
     move(str(directory / "_licences" / f"{licence}.txt"), str(directory / "LICENSE"))
     rmtree(str(directory / "_licences"))
 
 
 def remove_unused_files(directory: Path, module_name: str, need_to_remove_cli: bool) -> None:
-    """Remove unused files."""
+    """Remove unused files.
+
+    Args:
+        directory: path to the project directory
+        module_name: project module name
+        need_to_remove_cli: flag for removing CLI related files
+    """
     files_to_delete: List[Path] = []
 
     def _cli_specific_files() -> List[Path]:
@@ -47,7 +58,12 @@ def _cli_specific_files() -> List[Path]:
 
 
 def print_futher_instuctions(project_name: str, github: str) -> None:
-    """Show user what to do next after project creation."""
+    """Show user what to do next after project creation.
+
+    Args:
+        project_name: current project name
+        github: GitHub username
+    """
     message = f"""
     Your project {project_name} is created.
 

hooks/pre_gen_project.py

@@ -37,6 +37,9 @@ def validate_project_name(project_name: str) -> None:
     Valid inputs starts with the lowercase letter.
     Followed by any lowercase letters, numbers or underscores.
 
+    Args:
+        project_name: current project name
+
     Raises:
         ValueError: If project_name is not a valid Python module name
     """
@@ -48,6 +51,9 @@ def validate_project_name(project_name: str) -> None:
 def validate_semver(version: str) -> None:
     """Ensure version in semver notation.
 
+    Args:
+        version: string version. For example 0.1.2 or 1.2.4
+
     Raises:
         ValueError: If version is not in semver notation
     """
@@ -59,6 +65,9 @@ def validate_semver(version: str) -> None:
 def validate_line_length(line_length: int) -> None:
     """Validate line_length parameter. Length should be between 50 and 300.
 
+    Args:
+        line_length: integer paramenter for isort and black formatters
+
     Raises:
         ValueError: If line_length isn't between 50 and 300
     """