summaryrefslogtreecommitdiffstats
path: root/Doc/library/select.rst
diff options
context:
space:
mode:
authorSerhiy Storchaka <storchaka@gmail.com>2013-08-23 21:23:38 (GMT)
committerSerhiy Storchaka <storchaka@gmail.com>2013-08-23 21:23:38 (GMT)
commit9e0ae5398097e56490bcc720fe7ca56d50aec175 (patch)
treeaa3316a3e4c42c77d968d70962c9b4b449ec5821 /Doc/library/select.rst
parent78ede7c96d016eb0149c876bcb32633e3182e904 (diff)
downloadcpython-9e0ae5398097e56490bcc720fe7ca56d50aec175.zip
cpython-9e0ae5398097e56490bcc720fe7ca56d50aec175.tar.gz
cpython-9e0ae5398097e56490bcc720fe7ca56d50aec175.tar.bz2
Issue #18757: Improved cross-references in the concurrent package.
Diffstat (limited to 'Doc/library/select.rst')
-rw-r--r--Doc/library/select.rst32
1 files changed, 16 insertions, 16 deletions
diff --git a/Doc/library/select.rst b/Doc/library/select.rst
index 4e60f4a..b1fd3a8 100644
--- a/Doc/library/select.rst
+++ b/Doc/library/select.rst
@@ -78,7 +78,7 @@ The module defines the following:
This is a straightforward interface to the Unix :c:func:`select` system call.
The first three arguments are sequences of 'waitable objects': either
integers representing file descriptors or objects with a parameterless method
- named :meth:`fileno` returning such an integer:
+ named :meth:`~io.IOBase.fileno` returning such an integer:
* *rlist*: wait until ready for reading
* *wlist*: wait until ready for writing
@@ -104,8 +104,8 @@ The module defines the following:
objects <file object>` (e.g. ``sys.stdin``, or objects returned by
:func:`open` or :func:`os.popen`), socket objects returned by
:func:`socket.socket`. You may also define a :dfn:`wrapper` class yourself,
- as long as it has an appropriate :meth:`fileno` method (that really returns
- a file descriptor, not just a random integer).
+ as long as it has an appropriate :meth:`~io.IOBase.fileno` method (that
+ really returns a file descriptor, not just a random integer).
.. note::
@@ -119,7 +119,7 @@ The module defines the following:
.. attribute:: PIPE_BUF
The minimum number of bytes which can be written without blocking to a pipe
- when the pipe has been reported as ready for writing by :func:`select`,
+ when the pipe has been reported as ready for writing by :func:`~select.select`,
:func:`poll` or another interface in this module. This doesn't apply
to other kind of file-like objects such as sockets.
@@ -147,10 +147,10 @@ object.
.. method:: devpoll.register(fd[, eventmask])
Register a file descriptor with the polling object. Future calls to the
- :meth:`poll` method will then check whether the file descriptor has any pending
- I/O events. *fd* can be either an integer, or an object with a :meth:`fileno`
- method that returns an integer. File objects implement :meth:`fileno`, so they
- can also be used as the argument.
+ :meth:`poll` method will then check whether the file descriptor has any
+ pending I/O events. *fd* can be either an integer, or an object with a
+ :meth:`~io.IOBase.fileno` method that returns an integer. File objects
+ implement :meth:`!fileno`, so they can also be used as the argument.
*eventmask* is an optional bitmask describing the type of events you want to
check for. The constants are the same that with :c:func:`poll`
@@ -176,7 +176,7 @@ object.
Remove a file descriptor being tracked by a polling object. Just like the
:meth:`register` method, *fd* can be an integer or an object with a
- :meth:`fileno` method that returns an integer.
+ :meth:`~io.IOBase.fileno` method that returns an integer.
Attempting to remove a file descriptor that was never registered is
safely ignored.
@@ -288,10 +288,10 @@ linearly scanned again. :c:func:`select` is O(highest file descriptor), while
.. method:: poll.register(fd[, eventmask])
Register a file descriptor with the polling object. Future calls to the
- :meth:`poll` method will then check whether the file descriptor has any pending
- I/O events. *fd* can be either an integer, or an object with a :meth:`fileno`
- method that returns an integer. File objects implement :meth:`fileno`, so they
- can also be used as the argument.
+ :meth:`poll` method will then check whether the file descriptor has any
+ pending I/O events. *fd* can be either an integer, or an object with a
+ :meth:`~io.IOBase.fileno` method that returns an integer. File objects
+ implement :meth:`!fileno`, so they can also be used as the argument.
*eventmask* is an optional bitmask describing the type of events you want to
check for, and can be a combination of the constants :const:`POLLIN`,
@@ -330,7 +330,7 @@ linearly scanned again. :c:func:`select` is O(highest file descriptor), while
Remove a file descriptor being tracked by a polling object. Just like the
:meth:`register` method, *fd* can be an integer or an object with a
- :meth:`fileno` method that returns an integer.
+ :meth:`~io.IOBase.fileno` method that returns an integer.
Attempting to remove a file descriptor that was never registered causes a
:exc:`KeyError` exception to be raised.
@@ -390,8 +390,8 @@ http://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2
Value used to identify the event. The interpretation depends on the filter
but it's usually the file descriptor. In the constructor ident can either
- be an int or an object with a fileno() function. kevent stores the integer
- internally.
+ be an int or an object with a :meth:`~io.IOBase.fileno` method. kevent
+ stores the integer internally.
.. attribute:: kevent.filter