Skip to content

Commit

Permalink
Merge pull request #7 from robberwick/update-scan-doc-string
Browse files Browse the repository at this point in the history
Update docstrings to reflect returned values
  • Loading branch information
willyw0nka committed Jul 28, 2024
2 parents 6f2dd65 + 70cdccb commit bcde1ed
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions pygrype/grype.py
Original file line number Diff line number Diff line change
Expand Up @@ -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'],
Expand Down Expand Up @@ -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']

Expand Down

0 comments on commit bcde1ed

Please sign in to comment.