From 56bc176b2d963f34cb1d7e2fe5d771557bab2860 Mon Sep 17 00:00:00 2001
From: jb-alvarado <jb@pixelcrusher.de>
Date: Thu, 2 Jul 2020 22:30:06 +0200
Subject: [PATCH] add doc string

---
 ffplayout/output/hls.py | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/ffplayout/output/hls.py b/ffplayout/output/hls.py
index aead2c3a..25ec4b04 100644
--- a/ffplayout/output/hls.py
+++ b/ffplayout/output/hls.py
@@ -12,6 +12,12 @@ from ffplayout.utils import (_ff, _log, _playlist, _playout,
 
 
 def clean_ts():
+    """
+    this function get all *.m3u8 playlists from config,
+    read lines from them until it founds first *.ts file,
+    then it checks if files on harddrive are older then this first *.ts
+    and if so delete them
+    """
     playlists = [p for p in _playout.hls_output if 'm3u8' in p]
 
     for playlist in playlists: