feat: improve cli descriptions

Author: Hellgartner

README.md

@@ -42,23 +42,25 @@ Commands:
   generate  Generate an Opossum file from various other file formats.
 ```
 
-### `generate`
+### generate
 
 ```bash
-Usage: uv run opossum-file generate [OPTIONS]
+sage: opossum-file generate [OPTIONS]
 
   Generate an Opossum file from various other file formats.
 
   Currently supported input formats:
     - SPDX
 
 Options:
-  --spdx PATH         SPDX files used as input.
+  --spdx PATH         Specify a SPDX file that you would like to include in
+                      the final output.
+  --opossum PATH      Specify a .opossum file that you would like to include
+                      in the final output.
   -o, --outfile TEXT  The file path to write the generated opossum document
                       to. If appropriate, the extension ".opossum" will be
                       appended.  [default: output.opossum]
   --help              Show this message and exit.
-
 ```
 
 # Development

src/opossum_lib/cli.py

@@ -25,13 +25,13 @@ def opossum_file() -> None:
 @opossum_file.command()
 @click.option(
     "--spdx",
-    help="SPDX files used as input.",
+    help="Specify a SPDX file that you would like to include in the final output.",
     multiple=True,
     type=click.Path(exists=True),
 )
 @click.option(
     "--opossum",
-    help="opossum files used as input.",
+    help="Specify a .opossum file that you would like to include in the final output.",
     multiple=True,
     type=click.Path(exists=True),
 )

src/opossum_lib/opossum/read_opossum_file.py

@@ -26,7 +26,6 @@ def read_opossum_file(filename: str) -> OpossumInformation:
                 input_json = json.load(input_json_file)
                 return TypeAdapter(OpossumInformation).validate_python(input_json)
     except Exception as e:
-        # handle the exception
         print(f"Error reading file {filename}: {e}")
         sys.exit(1)