]> granicus.if.org Git - python/commitdiff
Replaced "string" with "bytes object" in docstrings of binary I/O objects.
authorSerhiy Storchaka <storchaka@gmail.com>
Thu, 9 Apr 2015 23:18:44 +0000 (02:18 +0300)
committerSerhiy Storchaka <storchaka@gmail.com>
Thu, 9 Apr 2015 23:18:44 +0000 (02:18 +0300)
Modules/_io/bytesio.c
Modules/_io/fileio.c

index 1537d979a31daa62b0ad01bedd8fb6f55332b6ed..4652356f318504c6ef273d56fb1fbae39cb5eb5e 100644 (file)
@@ -258,10 +258,10 @@ bytesio_tell(bytesio *self)
 }
 
 PyDoc_STRVAR(read_doc,
-"read([size]) -> read at most size bytes, returned as a string.\n"
+"read([size]) -> read at most size bytes, returned as a bytes object.\n"
 "\n"
 "If the size argument is negative, read until EOF is reached.\n"
-"Return an empty string at EOF.");
+"Return an empty bytes object at EOF.");
 
 static PyObject *
 bytesio_read(bytesio *self, PyObject *args)
@@ -307,10 +307,10 @@ bytesio_read(bytesio *self, PyObject *args)
 
 
 PyDoc_STRVAR(read1_doc,
-"read1(size) -> read at most size bytes, returned as a string.\n"
+"read1(size) -> read at most size bytes, returned as a bytes object.\n"
 "\n"
 "If the size argument is negative or omitted, read until EOF is reached.\n"
-"Return an empty string at EOF.");
+"Return an empty bytes object at EOF.");
 
 static PyObject *
 bytesio_read1(bytesio *self, PyObject *n)
@@ -326,11 +326,11 @@ bytesio_read1(bytesio *self, PyObject *n)
 }
 
 PyDoc_STRVAR(readline_doc,
-"readline([size]) -> next line from the file, as a string.\n"
+"readline([size]) -> next line from the file, as a bytes object.\n"
 "\n"
 "Retain newline.  A non-negative size argument limits the maximum\n"
 "number of bytes to return (an incomplete line may be returned then).\n"
-"Return an empty string at EOF.\n");
+"Return an empty bytes object at EOF.\n");
 
 static PyObject *
 bytesio_readline(bytesio *self, PyObject *args)
@@ -615,11 +615,11 @@ bytesio_write(bytesio *self, PyObject *obj)
 }
 
 PyDoc_STRVAR(writelines_doc,
-"writelines(sequence_of_strings) -> None.  Write strings to the file.\n"
+"writelines(lines) -> None.  Write bytes objects to the file.\n"
 "\n"
-"Note that newlines are not added.  The sequence can be any iterable\n"
-"object producing strings. This is equivalent to calling write() for\n"
-"each string.");
+"Note that newlines are not added.  The argument can be any iterable\n"
+"object producing bytes objects. This is equivalent to calling write() for\n"
+"each bytes object.");
 
 static PyObject *
 bytesio_writelines(bytesio *self, PyObject *v)
index 80ca99c5bcdc6c0a5cdbc4aef8d8baf5a54cb64f..23ca31d2d408e5f69266bc11e2a887c74391ca8b 100644 (file)
@@ -667,7 +667,7 @@ fileio_readall(fileio *self)
             if (bufsize > PY_SSIZE_T_MAX || bufsize <= 0) {
                 PyErr_SetString(PyExc_OverflowError,
                                 "unbounded read returned more bytes "
-                                "than a Python string can hold");
+                                "than a Python bytes object can hold");
                 Py_DECREF(result);
                 return NULL;
             }
@@ -1111,13 +1111,13 @@ PyDoc_STRVAR(read_doc,
 "\n"
 "Only makes one system call, so less data may be returned than requested\n"
 "In non-blocking mode, returns None if no data is available.\n"
-"On end-of-file, returns ''.");
+"Return an empty bytes object at EOF.");
 
 PyDoc_STRVAR(readall_doc,
 "readall() -> bytes.  read all data from the file, returned as bytes.\n"
 "\n"
 "In non-blocking mode, returns as much as is immediately available,\n"
-"or None if no data is available.  On end-of-file, returns ''.");
+"or None if no data is available.  Return an empty bytes object at EOF.");
 
 PyDoc_STRVAR(write_doc,
 "write(b: bytes) -> int.  Write bytes b to file, return number written.\n"