Add a note explaining the interaction between unbuffered input and

xreadlines.xreadlines().
This closes SF patch #552804.

diff --git a/Doc/lib/libxreadlines.tex b/Doc/lib/libxreadlines.tex
index d824fc3e8c6310d724de295ab148889ca92f480e..dda56e7f2fdef61fac23988068350fe71f4a630b 100644 (file)
--- 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