From d964387109ae8a21c43b745cce027d2f630a9abd Mon Sep 17 00:00:00 2001 From: Mohammad Abdollahpour Date: Sun, 8 Sep 2024 21:41:44 -0400 Subject: [PATCH] docs: mention that check files should end with _check suffix Signed-off-by: Mohammad Abdollahpour --- docs/source/pages/developers_guide/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/pages/developers_guide/index.rst b/docs/source/pages/developers_guide/index.rst index 94247a35c..eb56d1e6b 100644 --- a/docs/source/pages/developers_guide/index.rst +++ b/docs/source/pages/developers_guide/index.rst @@ -49,7 +49,7 @@ The Check Interface +++++++++++++++++++ Each check needs to be implemented as a Python class in a Python module under ``src/macaron/slsa_analyzer/checks``. -A check class should subclass the :class:`BaseCheck ` class. +A check class should subclass the :class:`BaseCheck ` class. The name of the source file containing the check should end with ``_check.py``. The main logic of a check should be implemented in the :func:`run_check ` abstract method. It is important to understand the input parameters and output objects computed by this method.