Skip to content

DOC: fix formatting read_csv comment kwarg explanation #8563

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

Merged
merged 1 commit into from
Oct 24, 2014
Merged

DOC: fix formatting read_csv comment kwarg explanation #8563

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions pandas/io/parsers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@ class ParserWarning(Warning):

Parameters
----------
filepath_or_buffer : string or file handle / StringIO. The string could be
a URL. Valid URL schemes include http, ftp, s3, and file. For file URLs, a
filepath_or_buffer : string or file handle / StringIO
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
file ://localhost/path/to/table.csv
%s
Expand All @@ -59,7 +60,8 @@ class ParserWarning(Warning):
dialect : string or csv.Dialect instance, default None
If None defaults to Excel dialect. Ignored if sep longer than 1 char
See csv.Dialect documentation for more details
header : int row number(s) to use as the column names, and the start of the
header : int, list of ints
Row number(s) to use as the column names, and the start of the
data. Defaults to 0 if no ``names`` passed, otherwise ``None``. Explicitly
pass ``header=0`` to be able to replace existing names. The header can be
a list of integers that specify row locations for a multi-index on the
Expand All @@ -78,7 +80,7 @@ class ParserWarning(Warning):
names : array-like
List of column names to use. If file contains no header row, then you
should explicitly pass header=None
prefix : string or None (default)
prefix : string, default None
Prefix to add to column numbers when no header, e.g 'X' for X0, X1, ...
na_values : list-like or dict, default None
Additional strings to recognize as NA/NaN. If dict passed, specific
Expand Down Expand Up @@ -113,7 +115,7 @@ class ParserWarning(Warning):
must be a single character. Like empty lines (as long as ``skip_blank_lines=True``),
fully commented lines are ignored by the parameter `header`
but not by `skiprows`. For example, if comment='#', parsing
'#empty\n1,2,3\na,b,c' with `header=0` will result in '1,2,3' being
'#empty\\na,b,c\\n1,2,3' with `header=0` will result in 'a,b,c' being
treated as the header.
decimal : str, default '.'
Character to recognize as decimal point. E.g. use ',' for European data
Expand Down