Skip to content

ENH/API: allow hist.bins to follow the numpy default #16471

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

tacaswell
Copy link
Member

Currently, we default to hist.bins=10 which happens to match the numpy
default. However, there is some discussion about changing the numpy
default. This adds the option of fall back to "what numpy does by default"
by default.

Changing the default currently has no effect, as the numpy default is
the same as our ould default, but will future-proof us to follow numpy
if / when they change their default.

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

Currently, we default to hist.bins=10 which happens to match
the numpy default.  However, there is some discussion about changing
the numpy default.  This adds the option of fall back to "what numpy
does by default" by default.
This will have no effect, as the numpy default is currently the same
as our default, but will future-proof us to follow numpy if / when
they change their default.
Copy link
Member

@jklymak jklymak left a comment

Choose a reason for hiding this comment

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

Overall this seems fine but needs docs. I think this needs a what’s new? And the new kwarg value need an entry in the docstring. Probably the template comment needs to be changed

@amueller
Copy link
Contributor

Ok so this changes the default as well, right?

@tacaswell
Copy link
Member Author

Punting to 3.4 as I don't think this is urgent (as I don't think there is a pending change to the numpy default coming).

@jklymak jklymak marked this pull request as draft September 10, 2020 15:43
@QuLogic QuLogic modified the milestones: v3.4.0, v3.5.0 Jan 21, 2021
@QuLogic QuLogic modified the milestones: v3.5.0, v3.6.0 Aug 23, 2021
@timhoffm timhoffm modified the milestones: v3.6.0, unassigned Apr 30, 2022
@story645 story645 modified the milestones: unassigned, needs sorting Oct 6, 2022
@github-actions
Copy link

Since this Pull Request has not been updated in 60 days, it has been marked "inactive." This does not mean that it will be closed, though it may be moved to a "Draft" state. This helps maintainers prioritize their reviewing efforts. You can pick the PR back up anytime - please ping us if you need a review or guidance to move the PR forward! If you do not plan on continuing the work, please let us know so that we can either find someone to take the PR over, or close it.

@github-actions github-actions bot added the status: inactive Marked by the “Stale” Github Action label Jul 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: inactive Marked by the “Stale” Github Action status: needs rebase
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants