From a3a93ae7c82542644c558a42141651cd74bfd81f Mon Sep 17 00:00:00 2001
From: Georg Brandl <georg@python.org>
Date: Fri, 20 Jan 2006 09:14:36 +0000
Subject: [PATCH] Bug #1396471: Document that Windows' ftell() can return
invalid values for text files with UNIX-style line endings.
---
Doc/lib/libstdtypes.tex | 6 +++++-
Misc/NEWS | 3 +++
2 files changed, 8 insertions(+), 1 deletion(-)
diff --git a/Doc/lib/libstdtypes.tex b/Doc/lib/libstdtypes.tex
index 656cb739b8..c2a7c88aa6 100644
--- a/Doc/lib/libstdtypes.tex
+++ b/Doc/lib/libstdtypes.tex
@@ -625,7 +625,7 @@ characters is assumed.
\begin{methoddesc}[string]{find}{sub\optional{, start\optional{, end}}}
Return the lowest index in the string where substring \var{sub} is
found, such that \var{sub} is contained in the range [\var{start},
-\var{end}). Optional arguments \var{start} and \var{end} are
+\var{end}]. Optional arguments \var{start} and \var{end} are
interpreted as in slice notation. Return \code{-1} if \var{sub} is
not found.
\end{methoddesc}
@@ -1598,6 +1598,10 @@ flush the read-ahead buffer.
\begin{methoddesc}[file]{tell}{}
Return the file's current position, like \code{stdio}'s
\cfunction{ftell()}.
+
+ \note{On Windows, \method{tell()} can return illegal values (after an
+ \cfunction{fgets()}) when reading files with \UNIX{}-style line-endings.
+ Use binary mode (\code{'rb'}) to circumvent this problem.}
\end{methoddesc}
\begin{methoddesc}[file]{truncate}{\optional{size}}
diff --git a/Misc/NEWS b/Misc/NEWS
index 62d9c8b151..1662110012 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -727,6 +727,9 @@ Tests
Documentation
-------------
+- Bug #1396471: Document that Windows' ftell() can return invalid
+ values for text files with UNIX-style line endings.
+
- Bug #1274828: Document os.path.splitunc().
- Bug #1190204: Clarify which directories are searched by site.py.
--
2.49.0