Skip to content
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

Clarify what options there are for read_options for calamine in read_excel #20593

Closed
mdavis-xyz opened this issue Jan 7, 2025 · 2 comments · Fixed by #20661
Closed

Clarify what options there are for read_options for calamine in read_excel #20593

mdavis-xyz opened this issue Jan 7, 2025 · 2 comments · Fixed by #20661
Labels
A-io-spreadsheet Area: reading/writing Excel/ODS files documentation Improvements or additions to documentation

Comments

@mdavis-xyz
Copy link
Contributor

mdavis-xyz commented Jan 7, 2025

Description

The docs for read_excel say:

read_options
Options passed to the underlying engine method that reads the sheet data. Where supported, this allows for additional control over parsing. The specific read methods associated with each engine are:
“calamine”: ExcelReader.load_sheet_by_name

There's no hyperlink there. I think there should be.

What is ExcelReader.load_sheet_by_name? It's quite hard to find. (I've never heard of calamine before.)

  • I went to the docs for the rust calamine crate here. There is no load_sheet_by_name
  • I looked up pycalamine. There is no load_sheet_by_name
  • Elsewhere in the docs for read_csv there is mention of fastexcel. here are the docs for that, which does have a load_sheet_by_name method

If that last link is correct, then I think the docs should have a hyperlink to it, or at least name which package the listed method is from.

Link

https://docs.pola.rs/api/python/dev/reference/api/polars.read_excel.html

@mdavis-xyz mdavis-xyz added the documentation Improvements or additions to documentation label Jan 7, 2025
@mdavis-xyz mdavis-xyz changed the title Clarify what options there are for read_options for calamine in read_csv Clarify what options there are for read_options for calamine in read_excel Jan 7, 2025
@cmdlineluser
Copy link
Contributor

Yeah, it's a bit confusing because the Python module name is fastexcel.

@alexander-beedie
Copy link
Collaborator

Yup, some links would be helpful here... 📖🤔

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-io-spreadsheet Area: reading/writing Excel/ODS files documentation Improvements or additions to documentation
Projects
None yet
3 participants