From 70cdccb9f1726ad3a3ba62145e35e31976bf3682 Mon Sep 17 00:00:00 2001 From: Rob Berwick Date: Sat, 27 Jul 2024 13:21:17 +0100 Subject: [PATCH] Update docs strings to reflect return values --- pygrype/grype.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pygrype/grype.py b/pygrype/grype.py index 962897a..12a84b5 100644 --- 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']