classification
Title: Fix the docstring for AbstractEventLoopPolicy.get_event_loop
Type: Stage:
Components: asyncio, Documentation Versions: Python 3.8, Python 3.7, Python 3.6
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: asvetlov, docs@python, drtyrsa, xtreak, yselivanov
Priority: normal Keywords:

Created on 2018-08-06 10:04 by drtyrsa, last changed 2018-09-20 11:25 by xtreak.

Messages (1)
msg323190 - (view) Author: Vlad Starostin (drtyrsa) * Date: 2018-08-06 10:04
The docstring says "This may be None or an instance of EventLoop". But docs explicitly state that get_event_loop "must never return None". The same docstring is also in the example in docs: https://docs.python.org/3.6/library/asyncio-eventloops.html#customizing-the-event-loop-policy

I propose changing it to:

def get_event_loop(self):
    """Get the event loop.

    Returns an instance of EventLoop or raises an exception.
    """

If the wording is ok, I'll make a PR.
History
Date User Action Args
2018-09-20 11:25:43xtreaksetnosy: + xtreak
2018-08-06 10:04:47drtyrsacreate