summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2002-05-01 03:31:42 (GMT)
committerFred Drake <fdrake@acm.org>2002-05-01 03:31:42 (GMT)
commita65375c3e35b150e764658532923cb36a85d3e9e (patch)
tree8716ae7d3e489a4189db0c037354f24bf0fa3a26
parent7938fab2855e7e0f16d6591591535f44de13f5fe (diff)
downloadcpython-a65375c3e35b150e764658532923cb36a85d3e9e.zip
cpython-a65375c3e35b150e764658532923cb36a85d3e9e.tar.gz
cpython-a65375c3e35b150e764658532923cb36a85d3e9e.tar.bz2
Explain what os.read() returns at end of file.
This closes SF bug #550409. Applying to release21-maint & release22-maint.
-rw-r--r--Doc/lib/libos.tex4
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/lib/libos.tex b/Doc/lib/libos.tex
index 834e562..c956ab1 100644
--- a/Doc/lib/libos.tex
+++ b/Doc/lib/libos.tex
@@ -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