-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
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
Conversation
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 \ |
There was a problem hiding this comment.
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.
Migrated from #11756 Here's what the IO docs would look like: |
looks like a couple of linting errors
|
43b57b4
to
be8bfad
Compare
Fixed long line lint errors. |
Parsing options | ||
''''''''''''''' | ||
|
||
:func:`~pandas.io.parsers.read_csv` and :func:`~pandas.io.parsers.read_table` |
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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.
be8bfad
to
20161d9
Compare
ok, ping when green. I think we can merge this. @jorisvandenbossche ok ? |
@frankcleary actually, pls add a note in whatsnew, maybe in Enhancements (with a link to the docs) |
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 |
@frankcleary looks good! @jorisvandenbossche ? |
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.