Skip to content

DOC: pd.read_csv doc-string clarification #11555 #12256

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

Conversation

frankcleary
Copy link
Contributor

closes #11555
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.

The string could be a URL. Valid URL schemes include
http, ftp, s3, and file. For file URLs, a
host is expected. For instance, a local file could be
filepath_or_buffer : str, pathlib.Path, py._path.local.LocalPath or any object \
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note the '' allows all the options to both obey the line character limit and be parsed into the html docs correctly. I'm not sure if it's a style we want or not.

@frankcleary
Copy link
Contributor Author

Migrated from #11756

Here's what the IO docs would look like:

screen shot 2016-02-07 at 9 30 19 pm

@jreback
Copy link
Contributor

jreback commented Feb 8, 2016

looks like a couple of linting errors

linting -> pandas/io
pandas/io/parsers.py:51:80: E501 line too long (80 > 79 characters)
pandas/io/parsers.py:54:80: E501 line too long (80 > 79 characters)
pandas/io/parsers.py:62:80: E501 line too long (80 > 79 characters)
pandas/io/parsers.py:67:80: E501 line too long (80 > 79 characters)

@jreback jreback added Docs IO CSV read_csv, to_csv labels Feb 8, 2016
@jreback jreback added this to the 0.18.0 milestone Feb 8, 2016
@frankcleary frankcleary force-pushed the gh11555-read_csv-docs branch from 43b57b4 to be8bfad Compare February 10, 2016 03:27
@frankcleary
Copy link
Contributor Author

Fixed long line lint errors.

Parsing options
'''''''''''''''

:func:`~pandas.io.parsers.read_csv` and :func:`~pandas.io.parsers.read_table`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you use the top-level namespace here? So just :func:~pandas.read_csv (actually `:func:`read_csv will work as well and even cleaner)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense, updated throughout the file.

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.
@frankcleary frankcleary force-pushed the gh11555-read_csv-docs branch from be8bfad to 20161d9 Compare February 11, 2016 15:30
@jreback
Copy link
Contributor

jreback commented Feb 11, 2016

ok, ping when green.

I think we can merge this.

@jorisvandenbossche ok ?

@jreback
Copy link
Contributor

jreback commented Feb 11, 2016

@frankcleary actually, pls add a note in whatsnew, maybe in Enhancements (with a link to the docs)

@jreback jreback closed this in a424bb2 Feb 12, 2016
@jreback
Copy link
Contributor

jreback commented Feb 12, 2016

thanks @frankcleary

when docs are built (prob a few hours), have a look: http://pandas-docs.github.io/pandas-docs-travis/

and if needed pls issue a follow up to correct

@jreback
Copy link
Contributor

jreback commented Feb 12, 2016

@frankcleary looks good!

@jorisvandenbossche
was wondering if we should put references (this for io.rst) in the 'doc-string' area to some of the examples
e.g. http://pandas-docs.github.io/pandas-docs-travis/io.html#na-values could be linked from the na_values option.

?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs IO CSV read_csv, to_csv
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: pd.read_csv doc-string clarification
3 participants