[Python-checkins] bpo-30935: update get_event_loop docs (GH-2731)

Miss Islington (bot) webhook-mailer at python.org
Tue May 29 15:33:32 EDT 2018


https://github.com/python/cpython/commit/51bf38f796c74c7dac5a3d09ad0004494470091c
commit: 51bf38f796c74c7dac5a3d09ad0004494470091c
branch: 3.6
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2018-05-29T12:33:29-07:00
summary:

bpo-30935: update get_event_loop docs (GH-2731)

(cherry picked from commit e55de2d77f10d524be0b426e587fbc820f76de71)

Co-authored-by: Mandeep Singh <daxlab at users.noreply.github.com>

files:
M Doc/library/asyncio-eventloops.rst
M Doc/whatsnew/3.6.rst

diff --git a/Doc/library/asyncio-eventloops.rst b/Doc/library/asyncio-eventloops.rst
index 7970e9039dfd..3aa9ffeff268 100644
--- a/Doc/library/asyncio-eventloops.rst
+++ b/Doc/library/asyncio-eventloops.rst
@@ -169,12 +169,15 @@ An event loop policy must implement the following interface:
       Get the event loop for the current context.
 
       Returns an event loop object implementing the :class:`AbstractEventLoop`
-      interface.
+      interface. In case called from coroutine, it returns the currently
+      running event loop.
 
       Raises an exception in case no event loop has been set for the current
       context and the current policy does not specify to create one. It must
       never return ``None``.
 
+      .. versionchanged:: 3.6
+
    .. method:: set_event_loop(loop)
 
       Set the event loop for the current context to *loop*.
diff --git a/Doc/whatsnew/3.6.rst b/Doc/whatsnew/3.6.rst
index 88146dc7bcb8..c5ccd85603c0 100644
--- a/Doc/whatsnew/3.6.rst
+++ b/Doc/whatsnew/3.6.rst
@@ -818,7 +818,7 @@ Notable changes in the :mod:`asyncio` module since Python 3.5.0
 (all backported to 3.5.x due to the provisional status):
 
 * The :func:`~asyncio.get_event_loop` function has been changed to
-  always return the currently running loop when called from couroutines
+  always return the currently running loop when called from coroutines
   and callbacks.
   (Contributed by Yury Selivanov in :issue:`28613`.)
 



More information about the Python-checkins mailing list