summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--Doc/lib/libxreadlines.tex4
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/lib/libxreadlines.tex b/Doc/lib/libxreadlines.tex
index d824fc3..dda56e7 100644
--- a/Doc/lib/libxreadlines.tex
+++ b/Doc/lib/libxreadlines.tex
@@ -38,7 +38,9 @@ former case.
\begin{funcdesc}{xreadlines}{fileobj}
Return a new xreadlines object which will iterate over the contents
of \var{fileobj}. \var{fileobj} must have a \method{readlines()}
- method that supports the \var{sizehint} parameter.
+ method that supports the \var{sizehint} parameter. \note{Because
+ the \method{readlines()} method buffers data, this effectively
+ ignores the effects of setting the file object as unbuffered.}
\end{funcdesc}
An xreadlines object \var{s} supports the following sequence