summaryrefslogtreecommitdiff
path: root/doc/modules/websocket.rst
diff options
context:
space:
mode:
authorJakub Stasiak <jakub@stasiak.at>2014-10-31 00:08:12 +0000
committerJakub Stasiak <jakub@stasiak.at>2014-10-31 00:08:12 +0000
commite22fe043559dad0d8428e29da18a26c1b3416832 (patch)
treeb292be10855a3aeac7dac54f941149b724189784 /doc/modules/websocket.rst
parent3bd19032e37768a9707ef36428f31d42865ff923 (diff)
downloadeventlet-docs.tar.gz
Improve documentationdocs
This patch: * exposes eventlet.greenthread.kill function so Sphinx generates its documentation and fixes broken links to :func:`kill` * adds warning about wsgi.server waiting for active connections to finish before returning
Diffstat (limited to 'doc/modules/websocket.rst')
-rw-r--r--doc/modules/websocket.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/modules/websocket.rst b/doc/modules/websocket.rst
index b42a25f..9a94fda 100644
--- a/doc/modules/websocket.rst
+++ b/doc/modules/websocket.rst
@@ -18,6 +18,11 @@ To create a websocket server, simply decorate a handler method with
wsgi.server(eventlet.listen(('', 8090)), hello_world)
+.. note::
+
+ Please see graceful termination warning in :func:`~eventlet.wsgi.server`
+ documentation
+
You can find a slightly more elaborate version of this code in the file
``examples/websocket.py``.