diff --git a/src/scripts/pycompare.py b/src/scripts/pycompare.py index 92420746426358d0c4327991d9126512c45db670..b253da6682e141465dfa56690cf8b08ca97a5071 100755 --- a/src/scripts/pycompare.py +++ b/src/scripts/pycompare.py @@ -1,4 +1,4 @@ -#!/bin/python +#!/bin/python3 ## @package pycompare # \brief Script to perform output consistency tests @@ -15,6 +15,8 @@ # error-level inconsistencies were found, or 1 otherwise. This can be used by # subsequent system calls to set up a testing suite checking whether the code # is able to reproduce legacy results. +# +# The script execution requires python3. import re @@ -376,6 +378,10 @@ def print_help(): ## \brief Add summary information to the HTML log file # +# In the case when a HTML log is requested, it is useful to obtain an overview +# of the detected inconsistencies. This function undertakes the task of adding +# a summary of the error, warning and noise counts on top of the log. +# # \param config: `dict` A dictionary containing the script configuration. # \param errors: `int` The number of errors detected by the comparison. # \param warnings: `int` The number of warnings detected by the comparison.