Skip to content

bpo-33649 : polish asyncio exceptions and platforms docs #9272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
1st1 merged 1 commit into from
Sep 13, 2018
Merged

bpo-33649 : polish asyncio exceptions and platforms docs #9272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions Doc/library/asyncio-exceptions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@ Exceptions

The operation has been cancelled.

This exception can be caught to perform custom operations on
This exception can be caught to perform custom operations
when asyncio Tasks are cancelled. In almost all situations the
exception must always be re-raised.

.. note::

This exception is a subclass of :exc:`Exception`, so it can be
accidentally suppressed by ``try..except`` block::

Expand Down Expand Up @@ -54,7 +55,7 @@ Exceptions

.. exception:: SendfileNotAvailableError

The "sendfile" syscall for is not available for the given
The "sendfile" syscall is not available for the given
socket or file type.

A subclass of :exc:`RuntimeError`.
Expand Down
9 changes: 5 additions & 4 deletions Doc/library/asyncio-platforms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ Platforms Support
=================

The :mod:`asyncio` module has been designed to be portable,
but some platforms have subtle differences and limitations.
but some platforms have subtle differences and limitations
due to the platforms' underlying architecture and capabilities.


All Platforms
Expand All @@ -26,7 +27,7 @@ All event loops on Windows do not support the following methods:

* :meth:`loop.create_unix_connection` and
:meth:`loop.create_unix_server` are not supported.
The :data:`socket.AF_UNIX` socket family is specific to UNIX/
The :data:`socket.AF_UNIX` socket family is specific to UNIX.

* :meth:`loop.add_signal_handler` and
:meth:`loop.remove_signal_handler` are not supported.
Expand Down Expand Up @@ -66,8 +67,8 @@ Windows configuration.
Subprocess Support on Windows
-----------------------------

:class:`SelectorEventLoop` on Windows does not support subproceses,
so :class:`ProactorEventLoop` should be used instead::
:class:`SelectorEventLoop` on Windows does not support subproceses.
On Windows, :class:`ProactorEventLoop` should be used instead::

import asyncio

Expand Down