Add docbloc for send_notification

This commit is contained in:
Landon Abney 2018-06-16 20:59:30 -07:00
parent 36c2ddaaf6
commit f7c555caa7
No known key found for this signature in database
GPG Key ID: 15320D3C4A506996

View File

@ -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,