Skip to content

DOC: fix RT03 error for pandas.DataFrame.hist #56864

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.

Sign up for GitHub

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
wants to merge 1 commit into from
Closed

DOC: fix RT03 error for pandas.DataFrame.hist #56864

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions pandas/plotting/_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,8 @@ def hist_frame(
Returns
-------
matplotlib.AxesSubplot or numpy.ndarray of them
An ndarray is returned with one :class:`matplotlib.AxesSubplot`
per column.
Comment on lines +231 to +232
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for fixing the style of the docstring @erichxchen.
I think think needs a bit more of work, as this doesn't seem very accurate. In general this will return the matplotlib object representing the histogram. This is what we should say first. Then, I'm not sure if an array is returned when by is used. Can you do some tests and make sure that what we provide here is relevant and correct please?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I will be working on this


See Also
--------
Expand Down