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

docs(python): Add links to read_excel "engine_options" and "read_options" docstring #20661

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

alexander-beedie
Copy link
Collaborator

@alexander-beedie alexander-beedie commented Jan 10, 2025

Closes #20593.

The documentation now provides links to help clarify the options available in read_excel for each backend (ref: the "read_options" and "engine_options" parameters):

image

Also: parametrized an Excel test and sorted the list of engines as a minor drive-by, and made a few other minor clarifications in the docstring.

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels Jan 10, 2025
@alexander-beedie alexander-beedie force-pushed the read-spreadsheet-links branch 5 times, most recently from 00ab4cf to b6d6689 Compare January 10, 2025 14:06
Copy link

codecov bot commented Jan 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.97%. Comparing base (04ad50d) to head (8561ca9).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #20661   +/-   ##
=======================================
  Coverage   78.97%   78.97%           
=======================================
  Files        1557     1557           
  Lines      220746   220743    -3     
  Branches     2527     2527           
=======================================
+ Hits       174326   174329    +3     
+ Misses      45842    45836    -6     
  Partials      578      578           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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 python Related to Python Polars
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify what options there are for read_options for calamine in read_excel
1 participant