]> granicus.if.org Git - python/commitdiff
Fix the doc for PIPE_BUF
authorAntoine Pitrou <solipsis@pitrou.net>
Tue, 25 Jan 2011 16:28:44 +0000 (16:28 +0000)
committerAntoine Pitrou <solipsis@pitrou.net>
Tue, 25 Jan 2011 16:28:44 +0000 (16:28 +0000)
Doc/library/select.rst

index 67309107b23250c15619c261a0f3b58902b57434..4804b1eecba09c5ecf11fb64987b797505a8bee5 100644 (file)
@@ -96,9 +96,11 @@ The module defines the following:
 
 .. attribute:: select.PIPE_BUF
 
-   Files reported as ready for writing by :func:`select`, :func:`poll` or
-   similar interfaces in this module are guaranteed to not block on a write
-   of up to :const:`PIPE_BUF` bytes.
+   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`,
+   :func:`poll` or another interface in this module.  This doesn't apply
+   to other kind of file-like objects such as sockets.
+
    This value is guaranteed by POSIX to be at least 512.  Availability: Unix.
 
    .. versionadded:: 3.2