Skip to content
Snippets Groups Projects
Commit 693696c7 authored by Giovanni La Mura's avatar Giovanni La Mura
Browse files

Add documentation to reformat_log()

parent 86234de0
No related branches found
No related tags found
No related merge requests found
#!/bin/python #!/bin/python3
## @package pycompare ## @package pycompare
# \brief Script to perform output consistency tests # \brief Script to perform output consistency tests
...@@ -15,6 +15,8 @@ ...@@ -15,6 +15,8 @@
# error-level inconsistencies were found, or 1 otherwise. This can be used by # 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 # subsequent system calls to set up a testing suite checking whether the code
# is able to reproduce legacy results. # is able to reproduce legacy results.
#
# The script execution requires python3.
import re import re
...@@ -376,6 +378,10 @@ def print_help(): ...@@ -376,6 +378,10 @@ def print_help():
## \brief Add summary information to the HTML log file ## \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 config: `dict` A dictionary containing the script configuration.
# \param errors: `int` The number of errors detected by the comparison. # \param errors: `int` The number of errors detected by the comparison.
# \param warnings: `int` The number of warnings detected by the comparison. # \param warnings: `int` The number of warnings detected by the comparison.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment