diff options
| author | engn33r <engn33r@users.noreply.github.com> | 2021-01-31 12:20:31 -0500 |
|---|---|---|
| committer | engn33r <engn33r@users.noreply.github.com> | 2021-01-31 12:20:31 -0500 |
| commit | aace06b24fef03d6d8f2c6d16c2e23325360c67b (patch) | |
| tree | 94fbf3181fc007f18ee28e7d66302f74cf93b4d3 /websocket/_socket.py | |
| parent | 15a92eed55cbdb2f389aa4059cc2b1fc9551edc5 (diff) | |
| download | websocket-client-aace06b24fef03d6d8f2c6d16c2e23325360c67b.tar.gz | |
Add first draft of Sphinx documentation
Diffstat (limited to 'websocket/_socket.py')
| -rw-r--r-- | websocket/_socket.py | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/websocket/_socket.py b/websocket/_socket.py index 7be3913..a3395ea 100644 --- a/websocket/_socket.py +++ b/websocket/_socket.py @@ -1,4 +1,8 @@ """ + +""" + +""" websocket - WebSocket client library for Python Copyright (C) 2010 Hiroki Ohtani(liris) @@ -62,7 +66,10 @@ def setdefaulttimeout(timeout): """ Set the global timeout setting to connect. - timeout: default socket timeout time. This value is second. + Parameters + ---------- + timeout: <type> + default socket timeout time. This value is second. """ global _default_timeout _default_timeout = timeout @@ -70,7 +77,12 @@ def setdefaulttimeout(timeout): def getdefaulttimeout(): """ - Return the global timeout setting(second) to connect. + Get default timeout + + Returns + ---------- + _default_timeout: <type> + Return the global timeout setting (in seconds) to connect. """ return _default_timeout |
