Skip to content

Commit 3cbb4b6

Browse files
committed
docs: improve the check descriptions automatically shown in terminal
Signed-off-by: behnazh-w <behnaz.hassanshahi@oracle.com>
1 parent a9a1ecf commit 3cbb4b6

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

src/macaron/slsa_analyzer/checks/build_as_code_check.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ class BuildAsCodeCheck(BaseCheck):
8686
def __init__(self) -> None:
8787
"""Initiate the BuildAsCodeCheck instance."""
8888
description = (
89-
"The build definition and configuration executed by the build "
89+
"Check if the build definition and configuration executed by the build "
9090
"service is verifiably derived from text file definitions "
9191
"stored in a version control system."
9292
)

src/macaron/slsa_analyzer/checks/detect_malicious_metadata_check.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,12 +77,12 @@ class MaliciousMetadataFacts(CheckFacts):
7777

7878

7979
class DetectMaliciousMetadataCheck(BaseCheck):
80-
"""This check analyzes the metadata of a package for malicious behavior."""
80+
"""This check analyzes a package for malicious behavior."""
8181

8282
def __init__(self) -> None:
8383
"""Initialize a check instance."""
8484
check_id = "mcn_detect_malicious_metadata_1"
85-
description = """This check analyzes the metadata of a package based on reports malicious behavior.
85+
description = """Check if the package is malicious.
8686
"""
8787
super().__init__(check_id=check_id, description=description, eval_reqs=[])
8888

0 commit comments

Comments
 (0)