DOC: Update docstring for read_excel #56543
Conversation
| When ``engine=None``, the following logic will be | ||
| used to determine the engine: |
There was a problem hiding this comment.
I do think it's good to have this logic documented, can you just move it out of the versionchanged instead?
There was a problem hiding this comment.
IIRC xlrd used to not only support xlsx files but at one point was even the default so we had to go through some lengths to document that transition as clearly as possible. We are a few years removed from that and since then all default read libraries have specialized in a given extension(s), so I think we can do without going into this detail in the docstring
There was a problem hiding this comment.
and since then all default read libraries have specialized in a given extension(s)
Where are the default read libraries documented? E.g. both openpyxl and calamine can read xlsx, and both pyxlsb and calamine can read xlsb.
There was a problem hiding this comment.
Calamine is never the default - you'd have to explicitly use that as an engine. Otherwise this is documented in the Excel section of the IO manual
https://pandas.pydata.org/pandas-docs/stable/user_guide/io.html#excel-files
There was a problem hiding this comment.
Granted that section could be rewritten to be a little clearer, but I think that is out of scope for what @phofl is doing here
There was a problem hiding this comment.
Calamine is never the default - you'd have to explicitly use that as an engine.
This is true today, but there is an issue to make it the default for xlsb files. In any case, I don't believe it's documented that Calamine is never the default.
There was a problem hiding this comment.
Updated and added back in without the version changed
pandas/io/excel/_base.py
Outdated
| @@ -165,31 +165,12 @@ | |||
| Supported engines: "xlrd", "openpyxl", "odf", "pyxlsb", "calamine". | |||
There was a problem hiding this comment.
Out of scope, but it appears to me this line is duplicative.
|
/preview |
|
Website preview of this PR available at: https://pandas.pydata.org/preview/56543/ |
|
I've also clarified the user guide |
|
Thanks @phofl |
…cel) (#56730) Backport PR #56543: DOC: Update docstring for read_excel Co-authored-by: Patrick Hoefler <[email protected]>
The initial motivation for this change was the typo in xlrd