docs: fix the docstrings and comments

Signed-off-by: behnazh-w <[email protected]>

Author: behnazh-w

src/macaron/build_spec_generator/build_spec_generator.py

@@ -71,7 +71,7 @@ def gen_build_spec_for_purl(
     build_spec_format: BuildSpecFormat,
     output_path: str,
 ) -> int:
-    """Return the content of a build spec file from a given PURL.
+    """Generate the build spec file for the given PURL in the specified output directory.
 
     Parameters
     ----------

src/macaron/build_spec_generator/cli_command_parser/gradle_cli_parser.py

@@ -537,7 +537,7 @@ def parse(self, cmd_list: list[str]) -> GradleCLICommand:
             parsed_opts = self.arg_parser.parse_args(options)
         except argparse.ArgumentError as error:
             raise CommandLineParseError(f"Failed to parse {' '.join(options)}.") from error
-        # Even though we have set `exit_on_error`, argparse still exists unexpectedly in some
+        # Even though we have set `exit_on_error`, argparse still exits unexpectedly in some
         # cases. This has been confirmed to be a bug in the argparse library implementation.
         # https://github.com/python/cpython/issues/121018.
         # This is fixed in Python3.12, but not Python3.11

src/macaron/build_spec_generator/cli_command_parser/maven_cli_parser.py

@@ -439,7 +439,7 @@ def parse(self, cmd_list: list[str]) -> "MavenCLICommand":
             parsed_opts = self.arg_parser.parse_args(options)
         except argparse.ArgumentError as error:
             raise CommandLineParseError(f"Failed to parse command {' '.join(options)}.") from error
-        # Even though we have set `exit_on_error`, argparse still exists unexpectedly in some
+        # Even though we have set `exit_on_error`, argparse still exits unexpectedly in some
         # cases. This has been confirmed to be a bug in the argparse library implementation.
         # https://github.com/python/cpython/issues/121018.
         # This is fixed in Python3.12, but not Python3.11