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

DOC: no docs for ExcelWriter engine_kwargs #42292 #42214 #43440

Closed
1 task done
feefladder opened this issue Sep 7, 2021 · 2 comments · Fixed by #43445
Closed
1 task done

DOC: no docs for ExcelWriter engine_kwargs #42292 #42214 #43440

feefladder opened this issue Sep 7, 2021 · 2 comments · Fixed by #43445
Labels
Docs IO Excel read_excel, to_excel
Milestone

Comments

@feefladder
Copy link
Contributor

  • I have checked that the issue still exists on the latest versions of the docs on master here

Location of the documentation

https://pandas.pydata.org/docs/dev/reference/api/pandas.ExcelWriter.html?highlight=excelwriter#pandas.ExcelWriter

Documentation problem

There is no use-case specified for engine_kwargs, as a result of which I was confused and made #42214. There, my test was overwritten by #42292 that uses the 'correct' use of engine_kwargs. How I did it first (incorrect):

import pandas as pd
with pd.ExcelWriter("file.xlsx",engine="xlsxwriter",engine_kwargs={"strings_to_formulas":False}) as writer:
    pd.DataFrame(["=1+1"]).to_excel(writer)

where it should have been:

import pandas as pd
with pd.ExcelWriter("file.xlsx",engine="xlsxwriter",engine_kwargs={"options":{"strings_to_formulas":False}}) as writer:
    pd.DataFrame(["=1+1"]).to_excel(writer)

However, since only xlsxwriter actually passes the engine_kwargs through to the Workbook class, this is unintuitive without documentation.

Suggested fix for documentation

I will submit a PR

@feefladder feefladder added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Sep 7, 2021
@simonjayhawkins simonjayhawkins added IO Excel read_excel, to_excel and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Sep 7, 2021
@simonjayhawkins simonjayhawkins added this to the Contributions Welcome milestone Sep 7, 2021
@acse-srm3018
Copy link

Hi. This is my first contribution to an open source project. Can I take this issue?

@feefladder
Copy link
Contributor Author

It's already solved by #43445. Thank you for contributing! This is really important. Normally issues you can take up have a 'contributions welcome' tag you can search for. 'Good first issue' means it is a good issue that you do not need very in-depth knowledge of Pandas of, so that is also a good place to start :)
And yes, then you comment

Take!

On an issue to notify people that you are working on that and they do not get double-solved. Here I said

I will submit a PR

Which is the same. Good luck and thanks!

Also please read the contributing guide, there this is explained.

@jreback jreback modified the milestones: Contributions Welcome, 1.4 Sep 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs IO Excel read_excel, to_excel
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants