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

updated hist documentation #19366

Merged
merged 4 commits into from
Feb 1, 2018
Merged

updated hist documentation #19366

merged 4 commits into from
Feb 1, 2018

Conversation

mitchnegus
Copy link
Contributor

@mitchnegus mitchnegus commented Jan 24, 2018

pandas.DataFrame.hist()/pandas.Series.hist() currently say that the bins keyword argument must be an integer, with a default value of 10. Since these methods are built off matplotlib, these actually seem to be more flexible (allowing sequences as well as integers). I don't know if there was a reason for this discrepancy, but if not, I've adjusted the pandas docstrings to reflect the matplotlib documentation.

Existing pandas documentation
Existing matplotlib documentation

  • closes #xxxx
  • tests added / passed
  • passes git diff upstream/master -u -- "*.py" | flake8 --diff
  • whatsnew entry

@pep8speaks
Copy link

pep8speaks commented Jan 24, 2018

Hello @mitchnegus! Thanks for updating the PR.

Cheers ! There are no PEP8 issues in this Pull Request. 🍻

Comment last updated on January 30, 2018 at 20:49 Hours UTC


Notes
-----
See matplotlib documentation online for more on this
Copy link
Member

@gfyoung gfyoung Jan 24, 2018

Choose a reason for hiding this comment

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

Could you point to a specific matplotlib function(s) with a "See Also" section in the docstring? As given, if I were a new user, I wouldn't really have an idea of where to go.

Copy link
Contributor

Choose a reason for hiding this comment

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

matplotlib.axes.Axes.hist might be turned into a link automatically, if you add it to "See Also".

@gfyoung gfyoung requested a review from TomAugspurger January 24, 2018 10:15
Copy link
Contributor

@TomAugspurger TomAugspurger left a comment

Choose a reason for hiding this comment

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

Could you also update hist_frame


Notes
-----
See matplotlib documentation online for more on this
Copy link
Contributor

Choose a reason for hiding this comment

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

matplotlib.axes.Axes.hist might be turned into a link automatically, if you add it to "See Also".

@codecov
Copy link

codecov bot commented Jan 24, 2018

Codecov Report

Merging #19366 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #19366   +/-   ##
=======================================
  Coverage   91.62%   91.62%           
=======================================
  Files         150      150           
  Lines       48724    48724           
=======================================
  Hits        44642    44642           
  Misses       4082     4082
Flag Coverage Δ
#multiple 89.99% <ø> (ø) ⬆️
#single 41.74% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/plotting/_core.py 82.41% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 238499a...d0e44e4. Read the comment docs.

@TomAugspurger
Copy link
Contributor

@mitchnegus do you have a chance to update based on these comments?

@mitchnegus
Copy link
Contributor Author

Yes, sorry, I got busy and had forgot about this. Thanks for the bump!

Copy link
Contributor

@TomAugspurger TomAugspurger left a comment

Choose a reason for hiding this comment

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

Thanks, this all looks good to me. Please ping if you see that all the CI tests have passed before we do.

@jreback jreback added this to the 0.23.0 milestone Feb 1, 2018
@jreback jreback merged commit c768829 into pandas-dev:master Feb 1, 2018
@jreback
Copy link
Contributor

jreback commented Feb 1, 2018

thanks!

harisbal pushed a commit to harisbal/pandas that referenced this pull request Feb 28, 2018
@mitchnegus mitchnegus deleted the hist-doc branch June 22, 2018 06:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants