From f7c555caa7a1a983fceb53392ac8a1ea28fe04a5 Mon Sep 17 00:00:00 2001 From: Landon Abney Date: Sat, 16 Jun 2018 20:59:30 -0700 Subject: [PATCH] Add docbloc for send_notification --- killstream/kill_stream.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/killstream/kill_stream.py b/killstream/kill_stream.py index 31b178b..7549898 100644 --- a/killstream/kill_stream.py +++ b/killstream/kill_stream.py @@ -64,7 +64,17 @@ SELECTOR = ['stream', 'allStreams'] def send_notification(subject_text, body_text, notifier_id): - # Send the notification through Tautulli + """Send a notification through Tautulli + + Parameters + ---------- + subject_text : str + The text to use for the subject line of the message. + body_text : str + The text to use for the body of the notification. + notifier_id : int + Tautulli Notification Agent ID to send the notification to. + """ payload = {'apikey': TAUTULLI_APIKEY, 'cmd': 'notify', 'notifier_id': notifier_id,