summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRaymond Hettinger <python@rcn.com>2005-01-07 04:33:44 (GMT)
committerRaymond Hettinger <python@rcn.com>2005-01-07 04:33:44 (GMT)
commit72b83c86a9c992bc7635dbeaa08bfa95ec033236 (patch)
tree642842522906d3326faa955d6706aaf2f031624d
parentbccc9a956a2f854db1c72392126d4a580dd1c830 (diff)
downloadcpython-72b83c86a9c992bc7635dbeaa08bfa95ec033236.zip
cpython-72b83c86a9c992bc7635dbeaa08bfa95ec033236.tar.gz
cpython-72b83c86a9c992bc7635dbeaa08bfa95ec033236.tar.bz2
SF patch 1094011: Docs for file() vs open().
-rw-r--r--Doc/lib/libfuncs.tex9
1 files changed, 6 insertions, 3 deletions
diff --git a/Doc/lib/libfuncs.tex b/Doc/lib/libfuncs.tex
index 95ca9eb..6b853f3 100644
--- a/Doc/lib/libfuncs.tex
+++ b/Doc/lib/libfuncs.tex
@@ -416,9 +416,12 @@ class C:
after any I/O has been performed, and there's no reliable way to
determine whether this is the case.}
- The \function{file()} constructor is new in Python 2.2. The previous
- spelling, \function{open()}, is retained for compatibility, and is an
- alias for \function{file()}.
+ The \function{file()} constructor is new in Python 2.2 and is an
+ alias for \function{open()}. Both spellings are equivalent. The
+ intent is for \function{open()} to continue to be preferred for use
+ as a factory function which returns a new \class{file} object. The
+ spelling, \class{file} is more suited to type testing (for example,
+ writing \samp{isinstance(f, file)}).
\end{funcdesc}
\begin{funcdesc}{filter}{function, list}