Skip to content

DOC: methods in see also section in the pandas.core.groupby.DataFrameGroupBy.agg are not hyperlinks #59695

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
specialkapa opened this issue Sep 3, 2024 · 4 comments · Fixed by #59699
Closed
1 task done

Comments

@specialkapa
Copy link
Contributor

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

pandas.core.groupby.DataFrameGroupBy.agg

Documentation problem

In the see also section the DataFrame.groupby.apply, DataFrame.groupby.transform and DataFrame..aggregate` methods though listed, they are not hyperlinks and thus the reader cannot navigate with ease but has to look for them instead

Suggested fix for documentation

I am not very familiar with the sphinx setup in pandas and thus cannot suggest an approach for fixing this. Perhaps there is a good reason that these methods are not hyperlinked, note sure

@specialkapa specialkapa added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Sep 3, 2024
@rhshadrach
Copy link
Member

Thanks for the report. The _agg_template_frame and _agg_template_series strings in pandas.core.groupby.groupby both have things like:

{klass}.groupby.apply : Apply function func group-wise
and combine the results together.

I think if we change this to {klass}GroupBy.apply, the link will resolve.

Further investigations and PRs to fix are welcome!

@rhshadrach rhshadrach added Groupby good first issue and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Sep 3, 2024
@BobChuckyJoe
Copy link

take

@doshi-kevin
Copy link
Contributor

take

@doshi-kevin doshi-kevin mentioned this issue Sep 3, 2024
1 task
@doshi-kevin
Copy link
Contributor

Hey @rhshadrach @specialkapa I have changed to GroupBy...please check once if it works and please merge this PR if it does. I am new to open source and eager to contribute. Open to changes and suggestions.

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.

4 participants