Skip to content

DOC: DataFrame.hist documentation cuts off mid-sentence #41421

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

Jump to bottom
Closed
asongtoruin opened this issue May 11, 2021 · 2 comments · Fixed by #41454
Closed

DOC: DataFrame.hist documentation cuts off mid-sentence #41421

asongtoruin opened this issue May 11, 2021 · 2 comments · Fixed by #41454
Assignees
@mdhsieh
Labels
Docs good first issue
Milestone
1.3

Comments

@asongtoruin
Copy link

Location of the documentation

pandas.DataFrame.hist

Documentation problem

The introduction to the documentation currently reads:

Make a histogram of the DataFrame’s.

A histogram is a representation of the distribution of data. This function calls matplotlib.pyplot.hist(), on each series in the DataFrame, resulting in one histogram per column.

As defined in pandas.plotting._core here. This first sentence seems incomplete - the DataFrame's what?

Suggested fix for documentation

The sentence should probably be completed, likely in a manner that matches pandas.DataFrame.plot.hist,
the simplest form of which is probably just

Make a histogram of the DataFrame's columns.

which might be a bit small to be its own PR, but could be wrapped together with marking column and figsize as optional parameters (currently also not reflected in the documentation)
@asongtoruin asongtoruin added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels May 11, 2021
@attack68 attack68 added good first issue and removed Needs Triage Issue that has not been reviewed by a pandas team member labels May 11, 2021
@mdhsieh
Copy link
Contributor

mdhsieh commented May 12, 2021

Hi, I'm a first-time contributor. Can I take this issue?

@mdhsieh
Copy link
Contributor

mdhsieh commented May 12, 2021

take

mdhsieh added a commit to mdhsieh/pandas that referenced this issue May 13, 2021
@mdhsieh
DOC: Complete first sentence in DataFrame.hist (pandas-dev#41421).
b400099 
Mark column and figsize as optional parameters.
@mdhsieh mdhsieh mentioned this issue May 13, 2021
Merged
4 tasks
@jreback jreback added this to the 1.3 milestone May 14, 2021
jreback pushed a commit that referenced this issue May 14, 2021
@mdhsieh
DOC: Complete first sentence in DataFrame.hist (#41421). (#41454)
ac026fa
JulianWgs pushed a commit to JulianWgs/pandas that referenced this issue Jul 3, 2021
@mdhsieh @JulianWgs
DOC: Complete first sentence in DataFrame.hist (pandas-dev#41421). (p…
15af85e 
…andas-dev#41454)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mdhsieh mdhsieh

Labels
Docs good first issue
Projects
None yet
Milestone
1.3
Development

Successfully merging a pull request may close this issue.

DOC: Complete first sentence in DataFrame.hist (#41421). mdhsieh/pandas
4 participants
@jreback @asongtoruin @attack68 @mdhsieh