Skip to content

Update documentation of read_csv to explain that index_col can be a string containg a column name #25502

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 7 commits into from
Mar 15, 2019
Merged

Update documentation of read_csv to explain that index_col can be a string containg a column name #25502

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c919b73
Update documentation of read_csv to explain that index_col can be a s…
kimsey0 Mar 1, 2019
f8d058b
Improve wording of documentation for index_col parameter in read_csv.
kimsey0 Mar 3, 2019
b65927e
Remove unnecessary documentation
kimsey0 Mar 14, 2019
8a81ba2
Improve formatting of read_csv documentation.
kimsey0 Mar 14, 2019
eb09a57
Improve formatting of read_csv documentation.
kimsey0 Mar 14, 2019
f4458ea
Remove tailing whitespace.
kimsey0 Mar 14, 2019
1aa334e
Remove unnecessary documentation
kimsey0 Mar 15, 2019
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
11 changes: 6 additions & 5 deletions doc/source/user_guide/io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,11 +110,12 @@ names : array-like, default ``None``
List of column names to use. If file contains no header row, then you should
explicitly pass ``header=None``. Duplicates in this list will cause
a ``UserWarning`` to be issued.
index_col : int or sequence or ``False``, default ``None``
Column to use as the row labels of the ``DataFrame``. If a sequence is given, a
MultiIndex is used. If you have a malformed file with delimiters at the end of
each line, you might consider ``index_col=False`` to force pandas to *not* use
the first column as the index (row names).
index_col : int/string or sequence of int/string or ``False``, default ``None``
Column(s) to use as the row labels of the ``DataFrame``, either given as string name or column index.
If a sequence of int/string is given, a MultiIndex is used.
Columns used for the index (row names) are dropped from the actual columns of the input dataframe.
They are accessible via ``.index``.
(Note: ``index_col=False`` can be used to force pandas to *not* use the first column as the index, e.g. when you have a malformed file with delimiters at the end of each line.)
usecols : list-like or callable, default ``None``
Return a subset of the columns. If list-like, all elements must either
be positional (i.e. integer indices into the document columns) or strings
Expand Down
13 changes: 8 additions & 5 deletions pandas/io/parsers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,14 @@
List of column names to use. If file contains no header row, then you
should explicitly pass ``header=None``. Duplicates in this list will cause
a ``UserWarning`` to be issued.
index_col : int, sequence or bool, optional
Column to use as the row labels of the DataFrame. If a sequence is given, a
MultiIndex is used. If you have a malformed file with delimiters at the end
of each line, you might consider ``index_col=False`` to force pandas to
not use the first column as the index (row names).
index_col : int/string or sequence of int/string or ``False``, default ``None``
Column(s) to use as the row labels of the ``DataFrame``, either given as
string name or column index. If a sequence of int/string is given, a
MultiIndex is used. Columns used for the index (row names) are dropped from
the actual columns of the input dataframe. They are accessible via
``.index``. (Note: ``index_col=False`` can be used to force pandas to *not*
use the first column as the index, e.g. when you have a malformed file with
delimiters at the end of each line.)
usecols : list-like or callable, optional
Return a subset of the columns. If list-like, all elements must either
be positional (i.e. integer indices into the document columns) or strings
Expand Down