[checkmk-commits] checktestlib: Extend docstring

Module: check_mk Branch: master Commit: a286003cd6c88f031ce4abeef3fb666e170fcb2e URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=a286003cd6c88f… Author: Konstantin Büttner <kb(a)mathias-kettner.de> Date: Wed Jan 17 17:38:20 2018 +0100 checktestlib: Extend docstring Change-Id: Ie7259737305bd6e0f1cbb28bc047569a12183af8 --- tests/checks/checktestlib.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/tests/checks/checktestlib.py b/tests/checks/checktestlib.py index ab1aa68..3a30989 100644 --- a/tests/checks/checktestlib.py +++ b/tests/checks/checktestlib.py @@ -73,6 +73,14 @@ class CheckResult(object): """ A check result potentially consisting of multiple subresults, as returned by yield-style checks + + Initializing test results using this has the following advantages: + -Some basic consistency checks are being performed, making sure the + check's result conforms to the API + -A common interface to test assertions is provided, regardless of whether + or not the check uses subresults via the yield-API + -The check's code is being run, and doesn't disappear in the yield-APIs + generator-induced laziness. """ def __init__(self, result):