[checkmk-commits] checktestlib.py: Add docstrings and a TODO

Module: check_mk Branch: master Commit: 1cbc6cde9c5ef92e35590519ff5c4b0fcda26a9e URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=1cbc6cde9c5ef9… Author: Konstantin Büttner <kb(a)mathias-kettner.de> Date: Mon Feb 5 17:36:38 2018 +0100 checktestlib.py: Add docstrings and a TODO Change-Id: Ifc207fac229fada4055445b42809320262469c6e --- tests/checks/checktestlib.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/tests/checks/checktestlib.py b/tests/checks/checktestlib.py index 8092a91..86691f0 100644 --- a/tests/checks/checktestlib.py +++ b/tests/checks/checktestlib.py @@ -133,6 +133,7 @@ class CheckResult(object): class DiscoveryEntry(Tuploid): + """A single entry as returned by the discovery (or in oldspeak: inventory) function.""" def __init__(self, entry): item, default_params = entry @@ -146,7 +147,15 @@ class DiscoveryEntry(Tuploid): class DiscoveryResult(object): + """ + The result of the discovery as a whole. + + Much like in the case of the check result, this also makes sure + that yield-based discovery functions run, and that no exceptions + get lost in the laziness. + """ + # TODO: Add some more consistency checks here. def __init__(self, result): self.entries = [] for entry in result: