Skip to content

DOC: Group optional dependencies by relevant topic #39594

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
nmay231 opened this issue Feb 4, 2021 · 1 comment · Fixed by #39715
Closed

DOC: Group optional dependencies by relevant topic #39594

nmay231 opened this issue Feb 4, 2021 · 1 comment · Fixed by #39715
Labels
Milestone

Comments

@nmay231
Copy link
Contributor

nmay231 commented Feb 4, 2021

Location of the documentation

URL: https://pandas.pydata.org/pandas-docs/stable/getting_started/install.html#optional-dependencies
File in GitHub: https://github.com/pandas-dev/pandas/blob/master/doc/source/getting_started/install.rst

Documentation problem

The list of optional dependencies is currently just listed in alphabetical order. However, I think it would be much more logical to group packages by topic (PyTables reads/writes hdf5 files, xlrd reads Excel files). Then you can compare/contrast which packages you should install for your usecase, e.g. should I install openpyxl or xlrd to read my excel files; I should research more about them.

Additionally, it might be helpful to include more detailed information about how they're different, but I am not as familiar with the minute differences between them. That will have to be for another time.

Suggested fix for documentation

I am willing to work on this.

I could either a) add a fourth column to the dependency table listing which group it is a part of (read/write HTML, read/write Excel), or b) split it into multiple tables with a minor header for each group.

Are there any issues with making this change, and which of those two actions should I prefer?

@nmay231 nmay231 added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Feb 4, 2021
@jreback
Copy link
Contributor

jreback commented Feb 4, 2021

multiple tables would be ok (prob need an other section for ones that don't group well)

@lithomas1 lithomas1 removed the Needs Triage Issue that has not been reviewed by a pandas team member label Feb 8, 2021
@lithomas1 lithomas1 added this to the Contributions Welcome milestone Feb 8, 2021
@jreback jreback modified the milestones: Contributions Welcome, 1.3 Feb 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants