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: Sort the pandas API reference navbar in alphabetical order #59164

Open
1 task done
jeropaul opened this issue Jul 2, 2024 · 3 comments
Open
1 task done

DOC: Sort the pandas API reference navbar in alphabetical order #59164

jeropaul opened this issue Jul 2, 2024 · 3 comments
Labels
Docs Needs Discussion Requires discussion from core team before further action

Comments

@jeropaul
Copy link

jeropaul commented Jul 2, 2024

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.loc.html

Documentation problem

The navigation bar in the API reference documentation is not sorted in alphabetical order!

current navigation example order copied directly from the page.

Dataframe
pandas.DataFrame
pandas.DataFrame.index
pandas.DataFrame.columns
pandas.DataFrame.dtypes
pandas.DataFrame.info
pandas.DataFrame.select_dtypes
pandas.DataFrame.values
pandas.DataFrame.axes
pandas.DataFrame.ndim
pandas.DataFrame.size
pandas.DataFrame.shape
pandas.DataFrame.memory_usage
pandas.DataFrame.empty

Why is this a problem?

As a developer starting to work with Python and Pandas
When reviewing the Pandas API reference docs
Then it is really easy to miss behaviour that I would want to use, because of how it is sorted

Suggested fix for documentation

Sort the documentation alphabetically.

@jeropaul jeropaul added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jul 2, 2024
@SiddheshBangar
Copy link
Contributor

@jeropaul Thanks for sharing this issue, I had a look into this, and it is actually a long list to be fixed. If it is required to be fixed let me know, I will open a PR

@rhshadrach
Copy link
Member

The order is in the sections that appear on this page - https://pandas.pydata.org/docs/reference/frame.html. Are we able to order that page independently of the sidebar? If not, I'd be -1 on having a lexicographical ordering across all DataFrame methods.

@rhshadrach rhshadrach added Needs Discussion Requires discussion from core team before further action and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Jul 4, 2024
@jeropaul
Copy link
Author

I also note that pandas.DataFrame.tail is listed in the navigation bar twice for the DataFrame... I suspect that this happens because it appears in both 'Reindexing / selection / label manipulation' and 'Indexing, iteration'. Not a significant issue but it is kinda weird.

Being honest I did not even notice the right hand side menu bar until @rhshadrach pointed it out...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Needs Discussion Requires discussion from core team before further action
Projects
None yet
Development

No branches or pull requests

3 participants