From ff0f8dfaca32c7c61ecc43ac8becdaf83aaf2a14 Mon Sep 17 00:00:00 2001
From: jaredgoldman <jaredgoldmandev@gmail.com>
Date: Wed, 12 Apr 2023 20:37:10 -0400
Subject: [PATCH] Improve client._get_ws_token docstring

---
 piker/brokers/kucoin.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/piker/brokers/kucoin.py b/piker/brokers/kucoin.py
index 1aadfccd..ff891f96 100644
--- a/piker/brokers/kucoin.py
+++ b/piker/brokers/kucoin.py
@@ -253,6 +253,8 @@ class Client:
         '''
         Fetch ws token needed for sub access:
         https://docs.kucoin.com/#apply-connect-token
+        returns a token and the interval we must ping
+        the server at to keep the connection alive
 
         '''
         token_type = 'private' if private else 'public'
@@ -261,6 +263,7 @@ class Client:
         )
 
         if data and 'token' in data:
+            # ping_interval is in ms
             ping_interval: int = data['instanceServers'][0]['pingInterval']
             return data['token'], ping_interval
         elif data: