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

Add link to Fastexcel docs on pl.read_excel(...) page for easy reference of valid options in the read_options=... arg #15640

Closed
DeflateAwning opened this issue Apr 13, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@DeflateAwning
Copy link
Contributor

Description

I would appreciate if you linked to the load_sheet_by_name(...) docs from the pl.read_excel(...) docs: https://fastexcel.toucantoco.dev/fastexcel.html#ExcelReader.load_sheet_by_name

It says that you can use the read_options={...} arg to pass arguments to the load_sheet_by_name function, but doesn't really give any info about what sort of options exist. A link to the docs would make this much easier to work with and look up.

Other Justifications

  • There are a lot of FastExcel libraries out there, including one in Java that's more popular. Finding the right docs in the first place is tough.
  • It'd be helpful.

Link

https://docs.pola.rs/py-polars/html/reference/api/polars.read_excel.html

@DeflateAwning DeflateAwning added the documentation Improvements or additions to documentation label Apr 13, 2024
@cmdlineluser
Copy link
Contributor

This has also been requested in a broader issue:

@alexander-beedie
Copy link
Collaborator

alexander-beedie commented Apr 14, 2024

Yup, agreed; I'm looking at this at the moment, along with an upgrade to read_ods to integrate the calamine (fastexcel) engine there too. Will close this out in favour of #15596 to avoid the duplicate issue 👌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants