diff options
| author | Damien George <damien.p.george@gmail.com> | 2018-03-15 15:50:51 +1100 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2018-03-15 15:50:51 +1100 |
| commit | 0db49c37a4e8d2516ea0206f4e800b907cd4221f (patch) | |
| tree | 9e0d9677ad47953eb577979dfd3060f79ad0c50f /docs/library/uselect.rst | |
| parent | c926e72750ddc410f2ae4f1b28d17dfb09b5ca2c (diff) | |
docs: Fix some references and RST markup to eliminate Sphinx warnings.
Diffstat (limited to 'docs/library/uselect.rst')
| -rw-r--r-- | docs/library/uselect.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/library/uselect.rst b/docs/library/uselect.rst index fb43f7e63..77d458473 100644 --- a/docs/library/uselect.rst +++ b/docs/library/uselect.rst @@ -35,10 +35,10 @@ Methods Register `stream` *obj* for polling. *eventmask* is logical OR of: - * `uselect.POLLIN` - data available for reading - * `uselect.POLLOUT` - more data can be written + * ``uselect.POLLIN`` - data available for reading + * ``uselect.POLLOUT`` - more data can be written - Note that flags like `uselect.POLLHUP` and `uselect.POLLERR` are + Note that flags like ``uselect.POLLHUP`` and ``uselect.POLLERR`` are *not* valid as input eventmask (these are unsolicited events which will be returned from `poll()` regardless of whether they are asked for). This semantics is per POSIX. @@ -63,7 +63,7 @@ Methods tuple, depending on a platform and version, so don't assume that its size is 2. The ``event`` element specifies which events happened with a stream and is a combination of ``uselect.POLL*`` constants described above. Note that - flags `uselect.POLLHUP` and `uselect.POLLERR` can be returned at any time + flags ``uselect.POLLHUP`` and ``uselect.POLLERR`` can be returned at any time (even if were not asked for), and must be acted on accordingly (the corresponding stream unregistered from poll and likely closed), because otherwise all further invocations of `poll()` may return immediately with |