docs: documented transforms chunk_events_by_key and merge_events_by_keys (#99)

Author: ErikBjare

aw_transform/chunk_events_by_key.py

@@ -10,6 +10,10 @@
 def chunk_events_by_key(
     events: List[Event], key: str, pulsetime: float = 5.0
 ) -> List[Event]:
+    """
+    "Chunks" adjacent events together which have the same value for a key, and stores the
+    original events in the :code:`subevents` key of the new event.
+    """
     chunked_events: List[Event] = []
     for event in events:
         if key not in event.data:

aw_transform/merge_events_by_keys.py

@@ -7,7 +7,11 @@
 
 
 def merge_events_by_keys(events, keys) -> List[Event]:
-    # The result will be a list of events without timestamp since they are merged
+    """
+    Sums the duration of all events which share a value for a key and returns a new event for each value.
+
+    .. note: The result will be a list of events without timestamp since they are merged.
+    """
     # Call recursively until all keys are consumed
     if len(keys) < 1:
         return events