From 1deee54e0cb0f681779259758a30f4fe142f1477 Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Fri, 28 Nov 2014 13:58:28 +0100 Subject: [PATCH] asyncio doc: reformat event loop policy doc --- Doc/library/asyncio-eventloops.rst | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/Doc/library/asyncio-eventloops.rst b/Doc/library/asyncio-eventloops.rst index b8710830f22..e891ed1711b 100644 --- a/Doc/library/asyncio-eventloops.rst +++ b/Doc/library/asyncio-eventloops.rst @@ -150,6 +150,7 @@ loop per thread that interacts with :mod:`asyncio`. The module-level functions :func:`get_event_loop` and :func:`set_event_loop` provide convenient access to event loops managed by the default policy. + Event loop policy interface --------------------------- @@ -157,22 +158,31 @@ An event loop policy must implement the following interface: .. class:: AbstractEventLoopPolicy + Event loop policy. + .. method:: get_event_loop() - Get the event loop for the current context. Returns an event loop object - implementing the :class:`BaseEventLoop` interface, or 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 should never return ``None``. + Get the event loop for the current context. + + Returns an event loop object implementing the :class:`BaseEventLoop` + interface. + + 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``. .. method:: set_event_loop(loop) - Set the event loop for the current context to *loop*. + Set the event loop for the current context to *loop*. .. method:: new_event_loop() - Create and return a new event loop object according to this policy's rules. - If there's need to set this loop as the event loop for the current context, - :meth:`set_event_loop` must be called explicitly. + Create and return a new event loop object according to this policy's + rules. + + If there's need to set this loop as the event loop for the current + context, :meth:`set_event_loop` must be called explicitly. + Access to the global loop policy --------------------------------