Skip to content

DOC: Inappropriate bolding in pandas.DataFrame.agg #52253

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
luke396 opened this issue Mar 28, 2023 · 4 comments · Fixed by #52267
Closed
1 task done

DOC: Inappropriate bolding in pandas.DataFrame.agg #52253

luke396 opened this issue Mar 28, 2023 · 4 comments · Fixed by #52267
Assignees
Labels
Apply Apply, Aggregate, Transform, Map Docs good first issue

Comments

@luke396
Copy link
Contributor

luke396 commented Mar 28, 2023

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/dev/reference/api/pandas.DataFrame.agg.html

Documentation problem

image

Here, it seems that the rendering is not appropriate (inappropriate bolding).

Suggested fix for documentation

Perhaps the parts under Return that do not belong to it should be unbolded, or the paragraph layout should be adjusted accordingly.

Maybe related:
https://pandas.pydata.org/docs/dev/reference/api/pandas.Series.agg.html

@luke396 luke396 added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Mar 28, 2023
@futureprogrammer360
Copy link
Contributor

The bolding is also present in https://pandas.pydata.org/docs/dev/reference/api/pandas.DataFrame.aggregate.html

@futureprogrammer360
Copy link
Contributor

I'm willing to work on this after the issue is confirmed and the desired behavior is determined.

@topper-123 topper-123 removed the Needs Triage Issue that has not been reviewed by a pandas team member label Mar 28, 2023
@topper-123
Copy link
Contributor

topper-123 commented Mar 28, 2023

This does indeed look wrong, so can confirm.

@futureprogrammer360, 👍 if you want to take this. The desired behavior is to have more sensibly bolded text. Now how to figure out why this does it wrong...

@futureprogrammer360
Copy link
Contributor

take

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Apply Apply, Aggregate, Transform, Map Docs good first issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants