]> granicus.if.org Git - python/commitdiff
Explain what os.read() returns at end of file.
authorFred Drake <fdrake@acm.org>
Wed, 1 May 2002 03:31:42 +0000 (03:31 +0000)
committerFred Drake <fdrake@acm.org>
Wed, 1 May 2002 03:31:42 +0000 (03:31 +0000)
This closes SF bug #550409.  Applying to release21-maint & release22-maint.

Doc/lib/libos.tex

index 834e56291fb55daccdf854c6cab7eb9830d469e1..c956ab1b22f3953ba7256cc773359f241597ca9b 100644 (file)
@@ -471,7 +471,9 @@ Availability: \UNIX, Windows.
 
 \begin{funcdesc}{read}{fd, n}
 Read at most \var{n} bytes from file descriptor \var{fd}.
-Return a string containing the bytes read.
+Return a string containing the bytes read.  If the end of the file
+referred to by \var{fd} has been reached, an empty string is
+returned.
 Availability: Macintosh, \UNIX, Windows.
 
 Note: this function is intended for low-level I/O and must be applied