From: Ben Darnell <ben@bendarnell.com>
Date: Sat, 22 Jun 2019 18:39:38 +0000 (-0400)
Subject: docs: Add notice about WindowsSelectorEventLoop on py38
X-Git-Tag: v6.1.0b1~66^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F2686%2Fhead;p=thirdparty%2Ftornado.git

docs: Add notice about WindowsSelectorEventLoop on py38

Fixes #2608
---

diff --git a/docs/index.rst b/docs/index.rst
index 6d2e1d73c..135fd099e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -120,6 +120,13 @@ is limited (Even though Tornado is built on ``asyncio``, which
 supports Windows, Tornado does not use the APIs that are necessary for
 scalable networking on Windows).
 
+On Windows, Tornado requires the ``WindowsSelectorEventLoop``. This is
+the default in Python 3.7 and older, but Python 3.8 defaults to an
+event loop that is not compatible with Tornado. Applications that use
+Tornado on Windows with Python 3.8 must call
+``asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())``
+at the beginning of their ``main`` file/function.
+
 Documentation
 -------------