Skip to content

Commit 9209345

Browse files
committed
DOC: correct iterator/chunksize docs in regards to return value (is TextFileReader), not TextParser
1 parent 89ada20 commit 9209345

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

doc/source/io.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,10 @@ They can take a number of arguments:
100100
Currently line commenting is not supported.
101101
- ``nrows``: Number of rows to read out of the file. Useful to only read a
102102
small portion of a large file
103-
- ``iterator``: If True, return a ``TextParser`` to enable reading a file
103+
- ``iterator``: If True, return a ``TextFileReader`` to enable reading a file
104104
into memory piece by piece
105105
- ``chunksize``: An number of rows to be used to "chunk" a file into
106-
pieces. Will cause an ``TextParser`` object to be returned. More on this
106+
pieces. Will cause an ``TextFileReader`` object to be returned. More on this
107107
below in the section on :ref:`iterating and chunking <io.chunking>`
108108
- ``skip_footer``: number of lines to skip at bottom of file (default 0)
109109
- ``converters``: a dictionary of functions for converting values in certain
@@ -837,7 +837,7 @@ rather than reading the entire file into memory, such as the following:
837837
838838
839839
By specifiying a ``chunksize`` to ``read_csv`` or ``read_table``, the return
840-
value will be an iterable object of type ``TextParser``:
840+
value will be an iterable object of type ``TextFileReader``:
841841

842842
.. ipython:: python
843843
@@ -848,7 +848,7 @@ value will be an iterable object of type ``TextParser``:
848848
print chunk
849849
850850
851-
Specifying ``iterator=True`` will also return the ``TextParser`` object:
851+
Specifying ``iterator=True`` will also return the ``TextFileReader`` object:
852852

853853
.. ipython:: python
854854

pandas/io/parsers.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,9 @@ class DateConversionError(Exception):
104104
nrows : int, default None
105105
Number of rows of file to read. Useful for reading pieces of large files
106106
iterator : boolean, default False
107-
Return TextParser object
107+
Return TextFileReader object
108108
chunksize : int, default None
109-
Return TextParser object for iteration
109+
Return TextFileReader object for iteration
110110
skipfooter : int, default 0
111111
Number of line at bottom of file to skip
112112
converters : dict. optional

0 commit comments

Comments
 (0)