From: Skip Montanaro <skip@pobox.com>
Date: Sat, 8 Dec 2007 14:37:43 +0000 (+0000)
Subject: Note that open() is the preferred way to open files (issue 1510).
X-Git-Tag: v2.6a1~901
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4e3ebe0baeba9a7b4a1dcfcadb8b042aef7eb5fb;p=python

Note that open() is the preferred way to open files (issue 1510).
---

diff --git a/Objects/fileobject.c b/Objects/fileobject.c
index 271f4cdc55..4dd5c712b7 100644
--- a/Objects/fileobject.c
+++ b/Objects/fileobject.c
@@ -2065,7 +2065,8 @@ PyDoc_STR(
 "opened for writing.  Add a 'b' to the mode for binary files.\n"
 "Add a '+' to the mode to allow simultaneous reading and writing.\n"
 "If the buffering argument is given, 0 means unbuffered, 1 means line\n"
-"buffered, and larger numbers specify the buffer size.\n"
+"buffered, and larger numbers specify the buffer size.  The preferred way\n"
+"to open a file is with the builtin open() function.\n"
 )
 PyDoc_STR(
 "Add a 'U' to mode to open the file for input with universal newline\n"
diff --git a/Python/bltinmodule.c b/Python/bltinmodule.c
index e1242fdede..92304b3862 100644
--- a/Python/bltinmodule.c
+++ b/Python/bltinmodule.c
@@ -1357,7 +1357,8 @@ builtin_open(PyObject *self, PyObject *args, PyObject *kwds)
 PyDoc_STRVAR(open_doc,
 "open(name[, mode[, buffering]]) -> file object\n\
 \n\
-Open a file using the file() type, returns a file object.");
+Open a file using the file() type, returns a file object.  This is the\n\
+preferred way to open a file.");
 
 
 static PyObject *