Skip to content

Minor documentation issues in asyncio BaseEventLoop #106634

Closed
@Spycho

Description

@Spycho

Firstly:

Returns an event loop object implementing the BaseEventLoop interface,

I think the AbstractEventLoopPolicy's get_event_loop function should not say:

Returns an event loop object implementing the BaseEventLoop interface

But rather:

Returns an event loop object implementing the AbstractEventLoop interface

AbstractEventLoop is more of a representation of the interface than BaseEventLoop, and AbstractEventLoop is the class that the docs instruct people to extend if they want to have a custom event loop, and specifically say to not extend BaseEventLoop. It's also easier to look at the interface via AbstractEventLoop, without all the implementation details getting in the way.

Secondly:

are scheduled for exactly the same time, it undefined which

Grammar error:

If two callbacks are scheduled for exactly the same time, it undefined which will be called first.

should read:

If two callbacks are scheduled for exactly the same time, it is undefined which will be called first.

Linked PRs

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions