6706: Add docstrings to close()

[arvados.git] / sdk / python / arvados / events.py

diff --git a/sdk/python/arvados/events.py b/sdk/python/arvados/events.py
index 4581f05b8ad9dd9830051ff2490b25c053379c8f..802b6477ee702d435a2e18003039a635c445ef06 100644 (file)
--- a/sdk/python/arvados/events.py
+++ b/sdk/python/arvados/events.py
@@ -41,6 +41,8 @@ class EventClient(WebSocketClient):
         self.stop.set()
 
     def close(self, code=1000, reason=''):
+        """Close event client and wait for it to finish."""
+
         # parent close() method sends a asynchronous "closed" event to the server
         super(EventClient, self).close(code, reason)
 
@@ -107,6 +109,8 @@ class PollClient(threading.Thread):
             self.stop.wait(1)
 
     def close(self):
+        """Close poll client and wait for it to finish."""
+
         self.stop.set()
         try:
             self.join()