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: xlsx and ods support unclear in ExcelWriter #48514

Open
1 task done
buhtz opened this issue Sep 12, 2022 · 2 comments
Open
1 task done

DOC: xlsx and ods support unclear in ExcelWriter #48514

buhtz opened this issue Sep 12, 2022 · 2 comments
Labels
Docs IO Excel read_excel, to_excel

Comments

@buhtz
Copy link

buhtz commented Sep 12, 2022

Pandas version checks

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

Location of the documentation

https://pandas.pydata.org/docs/reference/api/pandas.ExcelWriter.html

Documentation problem

This is not about the naming problem that "ExcelWriter" also supports ods files but is named "Excel" instead of "ExcelAndOds" or something better.

See the argument engine in the docu.

It should explain which engines (and packages behind) are used by default for the different possible filetypes. It only explains which one is deprecated.

See the argument engine_kwargs.

Here is a list of engines/packages. It is unclear if this are the engine strings that can be used with the engine keyword or if this are the package names.

For odf it seems that odswriter is the used engine. But that project seems dead because of the last commit in 2016 (6 years ago).

Looking around in the internet I also find tutorials using odfpy. Again it is not clear if this is the engine string or just the package name. But that tutorials quit old and it is unclear for me if this is supported or not.

I also found a tutorial using engine="odf" which is unclear which package is used here.

Suggested fix for documentation

Clearly differentiate between package names and the string that can be used for engine argument.

Make clear which engines/packages are supported for which file types.

@buhtz buhtz added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Sep 12, 2022
@mroeschke mroeschke added IO Excel read_excel, to_excel and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Sep 12, 2022
@WillAyd
Copy link
Member

WillAyd commented Sep 14, 2022

Pandas uses odfpy not odswriter. You can see that in the high level documentation:

https://pandas.pydata.org/docs/user_guide/io.html?highlight=odfpy#opendocument-spreadsheets

Of course open to any improvements you'd like to make to the excel page you've linked.

W.r.t. the naming of "ExcelWriter", the history of how this was developed was that opendoc support came way later than excel support. I think at the time we decided it wasn't worth any API churn for correctness when most people think of ods / excel files to be conceptually the same (at least as far as pandas is concerned). I don't see us changing that

@buhtz
Copy link
Author

buhtz commented Sep 15, 2022

Of course open to any improvements you'd like to make to the excel page you've linked.

I contributed what I thought that could be improved. That is what the issue is about.

Core devs know the package better and can write the correct content into the docu.

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

No branches or pull requests

3 participants