Update docs strings to reflect return values

willyw0nka · Jul 27, 2024 · 70cdccb · 70cdccb
1 parent 6f2dd65
commit 70cdccb
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/pygrype/grype.py b/pygrype/grype.py
@@ -39,7 +39,7 @@ def version(self) -> GrypeVersion:
         """Get the version of Grype.
 
         Returns:
-            Dict: A dictionary containing the version information.
+            GrypeVersion: An object representing the Grype Executable version information.
         """
         process = subprocess.run(
             args=[self.path, 'version', '--output', 'json'],
@@ -81,7 +81,7 @@ def scan(self, target: str, add_cpes_if_none: bool = False, by_cve: bool = False
             show_supressed (bool, optional): Whether to show suppressed vulnerabilities. Defaults to False.
 
         Returns:
-            Dict: A dictionary containing the scan results.
+            Scan: A Scan class instance representing the scan results.
         """
         args = [self.path, target, '--output', 'json']