Skip to content

DOC: fix read_excel and ExcelFile engine parameter description (#28231) #28245

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 2 commits into from
Sep 5, 2019
Merged

DOC: fix read_excel and ExcelFile engine parameter description (#28231) #28245

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1ea58b
DOC: fix read_excel and ExcelFile engine parameter description (#28231)
Aug 31, 2019
5ab6c8e
DOC: fix description for ExcelFile class (#28231)
Sep 5, 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
9 changes: 5 additions & 4 deletions pandas/io/excel/_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@

engine : str, default None
If io is not a buffer or path, this must be set to identify io.
Acceptable values are None or xlrd.
Acceptable values are None, "xlrd", "openpyxl" or "odf".
converters : dict, default None
Dict of functions for converting values in certain columns. Keys can
either be integers or column labels, values are functions that take one
Expand Down Expand Up @@ -783,11 +783,12 @@ class ExcelFile:
Parameters
----------
io : string, path object (pathlib.Path or py._path.local.LocalPath),
file-like object or xlrd workbook
If a string or path object, expected to be a path to xls or xlsx file.
a file-like object, xlrd workbook or openpypl workbook.
If a string or path object, expected to be a path to xls, xlsx or odf file.
engine : string, default None
If io is not a buffer or path, this must be set to identify io.
Acceptable values are None or ``xlrd``.
Acceptable values are None, ``xlrd``, ``openpyxl`` or ``odf``.
Note that ``odf`` reads tables out of OpenDocument formatted files.
"""

from pandas.io.excel._odfreader import _ODFReader
Expand Down