Skip to content

DOC: pd.read_csv doc-string clarification #11555

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.

Sign up for GitHub

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

Jump to bottom
Closed
jreback opened this issue Nov 9, 2015 · 0 comments
Closed

DOC: pd.read_csv doc-string clarification #11555

jreback opened this issue Nov 9, 2015 · 0 comments
Labels
Docs IO CSV read_csv, to_csv
Milestone
0.18.0

Comments

@jreback
Copy link
Contributor

jreback commented Nov 9, 2015

need to update the docs for read_csv to match the doc-string. Let's make sure they have the same text / examples as much as possible (and are in the same order and such).

In particular, the header option doesn't have header='infer' which is the default in the docs, but it exists in the doc-string.

Further, should show what this does:

       if kwds.get('header', 'infer') == 'infer':
            kwds['header'] = 0 if kwds.get('names') is None else None

meaning if the the header kw is not specified, this it is set to the first line if no names are specified, else None.
@jreback jreback added this to the Next Major Release milestone Nov 9, 2015
@frankcleary frankcleary mentioned this issue Dec 4, 2015
Closed
@jreback jreback modified the milestones: 0.18.0, Next Major Release Dec 4, 2015
frankcleary added a commit to frankcleary/pandas that referenced this issue Feb 8, 2016
@frankcleary
DOC: pd.read_csv doc-string clarification pandas-dev#11555
4112c9f 
Updated IO Tools documentation for read_csv() and read_table() to be consistent with the doc-string
and reorded keyword arguements to group them more logically. Also updated concat docs in merging.rst
to be consistent with doc-string.
@frankcleary frankcleary mentioned this issue Feb 8, 2016
Closed
frankcleary added a commit to frankcleary/pandas that referenced this issue Feb 11, 2016
@frankcleary
DOC: pd.read_csv doc-string clarification pandas-dev#11555
20161d9 
Updated IO Tools documentation for read_csv() and read_table() to be consistent with the doc-string,
also reordered keywords to group them more logically. Also updated merging.rst docs for concat.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs IO CSV read_csv, to_csv
Projects
None yet
Milestone
0.18.0
1 participant
@jreback