Skip to content

Commit 1d5f9f7

Browse files
docs: mention that check files should end with _check suffix (#856)
Signed-off-by: Mohammad Abdollahpour <[email protected]>
1 parent 3d5e35b commit 1d5f9f7

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/source/pages/developers_guide/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The Check Interface
4949
+++++++++++++++++++
5050

5151
Each check needs to be implemented as a Python class in a Python module under ``src/macaron/slsa_analyzer/checks``.
52-
A check class should subclass the :class:`BaseCheck <macaron.slsa_analyzer.checks.base_check.BaseCheck>` class.
52+
A check class should subclass the :class:`BaseCheck <macaron.slsa_analyzer.checks.base_check.BaseCheck>` class. The name of the source file containing the check should end with ``_check.py``.
5353

5454
The main logic of a check should be implemented in the :func:`run_check <macaron.slsa_analyzer.checks.base_check.BaseCheck.run_check>` abstract method. It is important to understand the input
5555
parameters and output objects computed by this method.

0 commit comments

Comments
 (0)