agent: Add docstring to IBatchableTelem

2021-06-29 10:34:43 -04:00 · 2021-06-29 10:34:43 -04:00 · 8281a9d738
parent f8579300b3
commit 8281a9d738
1 changed files with 5 additions and 0 deletions
--- a/monkey/infection_monkey/telemetry/i_batchable_telem.py
+++ b/monkey/infection_monkey/telemetry/i_batchable_telem.py
@ -7,6 +7,11 @@ from infection_monkey.telemetry.i_telem import ITelem


 class IBatchableTelem(ITelem, metaclass=abc.ABCMeta):
+    """
+    Extends the ITelem interface and enables telemetries to be aggregated into
+    batches.
+    """
+
    @abc.abstractmethod
    def get_telemetry_batch(self) -> Iterable:
        pass