Skip to content

Commit dff637a

Browse files
silentquasarjreback
authored andcommitted
DOC: Link to IO Tools docs
Addressing issue #11464 - Provide links to help for iterator and chunksize usage (since there's no docstring help for TextFileReader).
1 parent 4b6fcc0 commit dff637a

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

pandas/io/parsers.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ class ParserWarning(Warning):
3434
_parser_params = """Also supports optionally iterating or breaking of the file
3535
into chunks.
3636
37+
Additional help can be found in the `online docs for IO Tools
38+
<http://pandas.pydata.org/pandas-docs/stable/io.html>`_.
39+
3740
Parameters
3841
----------
3942
filepath_or_buffer : string or file handle / StringIO
@@ -133,9 +136,12 @@ class ParserWarning(Warning):
133136
nrows : int, default None
134137
Number of rows of file to read. Useful for reading pieces of large files
135138
iterator : boolean, default False
136-
Return TextFileReader object
139+
Return TextFileReader object for iteration or getting chunks with ``get_chunk()``.
137140
chunksize : int, default None
138-
Return TextFileReader object for iteration
141+
Return TextFileReader object for iteration. `See IO Tools docs for more
142+
information
143+
<http://pandas.pydata.org/pandas-docs/stable/io.html#io-chunking>`_ on
144+
``iterator`` and ``chunksize``.
139145
skipfooter : int, default 0
140146
Number of lines at bottom of file to skip (Unsupported with engine='c')
141147
converters : dict, default None

0 commit comments

Comments
 (0)