Fix get_platform_status return type

shanefontaine · Dec 29, 2018 · 882edac · 882edac
1 parent daa87fa
commit 882edac
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/ethfinex/public_client.py b/ethfinex/public_client.py
@@ -17,9 +17,11 @@ def __init__(self, api_url='https://api.ethfinex.com/v2'):
     def get_platform_status(self):
         """Get the current status of the platform.
 
+        A 0 operative means the platform is in maintenance mode.
+        A 1 operative means that the platform is operative.
+
         Returns:
-            1 = operative
-            0 = maintenance
+            [OPERATIVE]
         """
         return self._send_message('/platform/status')