Skip to content

DOC: Mention "StyleFrame" package in "DataFrame.to_excel()" #47525

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

Closed
1 task done
buhtz opened this issue Jun 28, 2022 · 9 comments
Closed
1 task done

DOC: Mention "StyleFrame" package in "DataFrame.to_excel()" #47525

buhtz opened this issue Jun 28, 2022 · 9 comments

Comments

@buhtz
Copy link

buhtz commented Jun 28, 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.DataFrame.to_excel.html

Documentation problem

It is not a "problem" but enhancement.

Suggested fix for documentation

Do suggest the StyleFrame package to be more flexibel with formating the excel output.

btw: I won't suggest to integrate StyleFrame into pandas. Formatting export outputs is not the job of pandas and I assume you agree with this. But is is an often mentioned "problem" in the internet community that the pandas excel output lacks of the possibility to formatting.

@buhtz buhtz added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jun 28, 2022
@datapythonista
Copy link
Member

I'm not sure exactly what you're proposing. StyleFrame seems to be a package independent from pandas. You should open the issue in their repository if you want their package to be more flexible.

I'm personally find to add a note on our to_excel docstring about StyleFrame. You can also add it to the Ecosystem page in our website.

@datapythonista datapythonista added good first issue and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Jun 28, 2022
@buhtz
Copy link
Author

buhtz commented Jun 28, 2022

Yes a note would be fine. That was what I mean.

@rhshadrach
Copy link
Member

I'm not sure we want to be including third party libraries in the API docs unless it's necessary - it seems to be blurring the lines between ecosystem and API docs. +1 on adding to the ecosystem page.

@attack68
Copy link
Contributor

The StyleFrame documentation does not make it clear to me the specific features, in particular the specific features beyond pandas.Styler own capabilities, which for example can already style:

  • background colors,
  • text colors,
  • font styles,
  • borders,
  • number formats,

I think if we add a third party library to ecosystem, it would be worthwhile stating what it can do, extra, that pandas cannot.

@datapythonista
Copy link
Member

Fully agree. My understanding is that pandas styler formats to display in html, and StyleFrame formats an exported Excel. I didn't check in detail, but agree that if we add it to the Ecosystem we need a description so users know what it is and when it can be useful to them.

@akshay-babbar
Copy link
Contributor

Hi there, i am a user of pandas and want to contribute for the very first time. Can i take this issue?

@attack68
Copy link
Contributor

the issue already has an open pull request. please find another issue to tackle.

@datapythonista
Copy link
Member

From the discussion in #47533, it's unclear why pandas users would use StyleFrame, as the pandas Styler seems to provide the same functionality. We can surely be missing something, if someone knows in which cases StyleFrame should be preferred. please feel free to add a section about it in our Ecosystem page explaining it. But for the time being, closing this issue, as no action is expected.

@datapythonista
Copy link
Member

Just realized that the original point here was to add the external StyleFrame class to to_excel, not to the Ecosystem page. While it doesn't seem a good idea to do that, looks like a good idea to add our pandas Styler to it. I created #48019 for it (I thought it was better to create a new issue better than reopen this).

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

Successfully merging a pull request may close this issue.

5 participants