Skip to content

DOC: description of read_csv parameter chunksize does not mention its value is number of lines per chunk #53835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
1 task done
tpaxman opened this issue Jun 25, 2023 · 1 comment · Fixed by #53836
Closed
1 task done
Assignees
Labels

Comments

@tpaxman
Copy link
Contributor

tpaxman commented Jun 25, 2023

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://pandas.pydata.org/docs/dev/reference/api/pandas.read_csv.html

Documentation problem

Current description of chunksize only mentions that TextFileReader will be the return value but does not state that its value is the number of lines per chunk:

chunksize : int, optional
    Return ``TextFileReader`` object for iteration.
    See the `IO Tools docs
    <https://pandas.pydata.org/pandas-docs/stable/io.html#io-chunking>`_
    for more information on ``iterator`` and ``chunksize``.

Suggested fix for documentation

Add a sentence to the description to specify that it represents number of lines per chunk.

@tpaxman tpaxman added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jun 25, 2023
@lithomas1 lithomas1 removed the Needs Triage Issue that has not been reviewed by a pandas team member label Jun 25, 2023
@tpaxman
Copy link
Contributor Author

tpaxman commented Jun 26, 2023

Take

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
2 participants