Added comments

src/codergpt/cli.py

@@ -1,4 +1,24 @@
-"""Command line interface for CoderGPT."""
+"""
+Command line interface for CoderGPT.
+
+Author: Harshad Hegde
+
+This module provides a command line interface (CLI) for CoderGPT, a powerful code generation tool.
+
+Usage:
+    python codergpt_cli.py [OPTIONS] COMMAND [ARGS]...
+
+Options:
+    -v, --verbose INTEGER    Verbosity level (0, 1 or 2).
+    -q, --quiet              Run in quiet mode.
+    --version                Show the version and exit.
+
+Commands:
+    inspect     Inspect package to show file-language-map.
+    explain     Inspect package to show file-language-map.
+    comment     Inspect package to show file-language-map.
+
+"""
 
 import logging
 from pathlib import Path
@@ -22,7 +42,6 @@
 
 coder = CoderGPT()
 
-
 @click.group()
 @click.option("-v", "--verbose", count=True)
 @click.option("-q", "--quiet")
@@ -43,20 +62,28 @@ def main(verbose: int, quiet: bool):
     if quiet:
         logger.setLevel(level=logging.ERROR)
 
-
 @main.command()
 @path_argument
 def inspect(path: Union[str, Path, TextIO]):
-    """Inspect package to show file-language-map."""
-    coder.inspect_package(path=path)
+    """
+    Inspect package to show file-language-map.
 
+    :param path: Path to the package.
+    """
+    coder.inspect_package(path=path)
 
 @main.command()
 @path_argument
 @click.option("-f", "--function", help="Function name to explain.")
 @click.option("-c", "--classname", help="Class name to explain.")
 def explain(path: Union[str, Path], function: str, classname: str):
-    """Inspect package to show file-language-map."""
+    """
+    Inspect package to show file-language-map.
+
+    :param path: Path to the package.
+    :param function: Name of the function to explain.
+    :param classname: Name of the class to explain.
+    """
     # Ensure path is a string or Path object for consistency
     if isinstance(path, str):
         path = Path(path)
@@ -67,12 +94,16 @@ def explain(path: Union[str, Path], function: str, classname: str):
     else:
         raise ValueError("The path provided is not a file.")
 
-
 @main.command("comment")
 @path_argument
 @overwrite_option
 def add_comments(path: Union[str, Path], overwrite: bool = False):
-    """Inspect package to show file-language-map."""
+    """
+    Inspect package to show file-language-map.
+
+    :param path: Path to the package.
+    :param overwrite: Flag to indicate whether to overwrite existing files.
+    """
     # Ensure path is a string or Path object for consistency
     if isinstance(path, str):
         path = Path(path)
@@ -83,6 +114,5 @@ def add_comments(path: Union[str, Path], overwrite: bool = False):
     else:
         raise ValueError("The path provided is not a file.")
 
-
 if __name__ == "__main__":
     main()