From 0ba8e2bda01f022ed29cedc92194b57baec00a7b Mon Sep 17 00:00:00 2001 From: Landon Abney Date: Sat, 16 Jun 2018 23:19:30 -0700 Subject: [PATCH] Add a docstring for terminate_session --- killstream/kill_stream.py | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/killstream/kill_stream.py b/killstream/kill_stream.py index ecef18f..310d353 100644 --- a/killstream/kill_stream.py +++ b/killstream/kill_stream.py @@ -144,7 +144,19 @@ def get_user_session_ids(user_id): def terminate_session(session_id, message, notifier=None, username=None): - # Stop a streaming session. + """Stop a streaming session. + + Parameters + ---------- + session_id : str + The session ID of the stream to terminate. + message : str + The message to display to the user when terminating a stream. + notifier : int + Notification agent ID to send a message to (the default is None). + username : str + The username for the terminated session (the default is None). + """ payload = {'apikey': TAUTULLI_APIKEY, 'cmd': 'terminate_session', 'session_id': session_id,