summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSkip Montanaro <skip@pobox.com>2007-12-08 14:37:43 (GMT)
committerSkip Montanaro <skip@pobox.com>2007-12-08 14:37:43 (GMT)
commit4e3ebe0baeba9a7b4a1dcfcadb8b042aef7eb5fb (patch)
tree1bb48ca261de00182fc2d7068c24cfb2f1df39a4
parente40a6a85ee46019b5473f3240058612f7ee88ae5 (diff)
downloadcpython-4e3ebe0baeba9a7b4a1dcfcadb8b042aef7eb5fb.zip
cpython-4e3ebe0baeba9a7b4a1dcfcadb8b042aef7eb5fb.tar.gz
cpython-4e3ebe0baeba9a7b4a1dcfcadb8b042aef7eb5fb.tar.bz2
Note that open() is the preferred way to open files (issue 1510).
-rw-r--r--Objects/fileobject.c3
-rw-r--r--Python/bltinmodule.c3
2 files changed, 4 insertions, 2 deletions
diff --git a/Objects/fileobject.c b/Objects/fileobject.c
index 271f4cd..4dd5c71 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 e1242fd..92304b3 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 *