docs

LUCIT-Systems-and-Development · Dec 2, 2020 · 2f99a21 · 2f99a21
1 parent 59ece82
commit 2f99a21
Show file tree

Hide file tree

Showing 11 changed files with 14 additions and 12 deletions.
diff --git a/docs/CHANGELOG.html b/docs/CHANGELOG.html
@@ -1933,7 +1933,7 @@ <h3>Navigation</h3>
     &copy; <a href="copyright.html">Copyright</a> 2020, Oliver Zehentleitner.
     <br />
 
-    Last updated on Dec 02 2020 at 03:44 (CET).
+    Last updated on Dec 02 2020 at 03:51 (CET).
     <a href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/issues">Found a bug</a>?
     <br />
 

diff --git a/docs/README.html b/docs/README.html
@@ -617,7 +617,7 @@ <h3>Navigation</h3>
     &copy; <a href="copyright.html">Copyright</a> 2020, Oliver Zehentleitner.
     <br />
 
-    Last updated on Dec 02 2020 at 03:44 (CET).
+    Last updated on Dec 02 2020 at 03:51 (CET).
     <a href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/issues">Found a bug</a>?
     <br />
 

diff --git a/docs/copyright.html b/docs/copyright.html
@@ -165,7 +165,7 @@ <h3>Navigation</h3>
     &copy; <a href="#">Copyright</a> 2020, Oliver Zehentleitner.
     <br />
 
-    Last updated on Dec 02 2020 at 03:44 (CET).
+    Last updated on Dec 02 2020 at 03:51 (CET).
     <a href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/issues">Found a bug</a>?
     <br />
 

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -559,7 +559,7 @@ <h3>Navigation</h3>
     &copy; <a href="copyright.html">Copyright</a> 2020, Oliver Zehentleitner.
     <br />
 
-    Last updated on Dec 02 2020 at 03:44 (CET).
+    Last updated on Dec 02 2020 at 03:51 (CET).
     <a href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/issues">Found a bug</a>?
     <br />
 

diff --git a/docs/index.html b/docs/index.html
@@ -631,7 +631,7 @@ <h3>Navigation</h3>
     &copy; <a href="copyright.html">Copyright</a> 2020, Oliver Zehentleitner.
     <br />
 
-    Last updated on Dec 02 2020 at 03:44 (CET).
+    Last updated on Dec 02 2020 at 03:51 (CET).
     <a href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/issues">Found a bug</a>?
     <br />
 

diff --git a/docs/modules.html b/docs/modules.html
@@ -173,7 +173,7 @@ <h3>Navigation</h3>
     &copy; <a href="copyright.html">Copyright</a> 2020, Oliver Zehentleitner.
     <br />
 
-    Last updated on Dec 02 2020 at 03:44 (CET).
+    Last updated on Dec 02 2020 at 03:51 (CET).
     <a href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/issues">Found a bug</a>?
     <br />
 

diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -175,7 +175,7 @@ <h3>Navigation</h3>
     &copy; <a href="copyright.html">Copyright</a> 2020, Oliver Zehentleitner.
     <br />
 
-    Last updated on Dec 02 2020 at 03:44 (CET).
+    Last updated on Dec 02 2020 at 03:51 (CET).
     <a href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/issues">Found a bug</a>?
     <br />
 

diff --git a/docs/search.html b/docs/search.html
@@ -135,7 +135,7 @@ <h3>Navigation</h3>
     &copy; <a href="copyright.html">Copyright</a> 2020, Oliver Zehentleitner.
     <br />
 
-    Last updated on Dec 02 2020 at 03:44 (CET).
+    Last updated on Dec 02 2020 at 03:51 (CET).
     <a href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/issues">Found a bug</a>?
     <br />
 

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/unicorn_binance_websocket_api.html b/docs/unicorn_binance_websocket_api.html
@@ -179,7 +179,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 with the default setting “raw_data” the output remains unchanged and gets delivered as
 received from the endpoints. Change this for a specific stream with the <cite>output</cite> parameter
 of <cite>create_stream()</cite> and <cite>replace_stream()</cite></p></li>
-<li><p><strong>enable_stream_signal_buffer</strong> (<em>bool</em>) – set to True to enable the <cite>stream_signal_buffer</cite> and receive information about
+<li><p><strong>enable_stream_signal_buffer</strong> (<em>bool</em>) – set to True to enable the
+<cite>stream_signal_buffer &lt;https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/wiki/%60stream_signal_buffer%60&gt;_</cite> and receive information about
 disconnects and reconnects to manage a restore of the lost data during the
 interruption or to recognize your bot got blind.</p></li>
 </ul>
@@ -1940,7 +1941,7 @@ <h3>Navigation</h3>
     &copy; <a href="copyright.html">Copyright</a> 2020, Oliver Zehentleitner.
     <br />
 
-    Last updated on Dec 02 2020 at 03:44 (CET).
+    Last updated on Dec 02 2020 at 03:51 (CET).
     <a href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/issues">Found a bug</a>?
     <br />
 

diff --git a/unicorn_binance_websocket_api/unicorn_binance_websocket_api_manager.py b/unicorn_binance_websocket_api/unicorn_binance_websocket_api_manager.py
@@ -135,7 +135,8 @@ class BinanceWebSocketApiManager(threading.Thread):
                            received from the endpoints. Change this for a specific stream with the `output` parameter
                            of `create_stream()` and `replace_stream()`
     :type output_default: str
-    :param enable_stream_signal_buffer: set to True to enable the `stream_signal_buffer` and receive information about
+    :param enable_stream_signal_buffer: set to True to enable the
+                                        `stream_signal_buffer <https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/wiki/%60stream_signal_buffer%60>_` and receive information about
                                         disconnects and reconnects to manage a restore of the lost data during the
                                         interruption or to recognize your bot got blind.
     :type enable_stream_signal_buffer: bool