Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docstrings to reflect returned values #7

Merged
merged 1 commit into from
Jul 28, 2024
Merged

Update docstrings to reflect returned values #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pygrype/grype.py
View file
Open in desktop
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
Loading