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

Default values of the histogram bins in analysis #366

Open
snilsn opened this issue Nov 14, 2023 · 2 comments
Open

Default values of the histogram bins in analysis #366

snilsn opened this issue Nov 14, 2023 · 2 comments
Labels
good first issue An ideal issue for new contributors to address Low Priority This issue does not need addressing until a future update
Milestone

Comments

@snilsn
Copy link
Collaborator

snilsn commented Nov 14, 2023

I just clicked on the API reference in the documentation and noticed that the default bin edge values for all the histogram functions are these really long, hand-coded lists of numbers. This is not really a high priority, but it just doesn't look professional and could be done much more compactly with np.arange().

I don't know if these functions are actually used that much, and maybe I'm the only one who's annoyed by this, but it's one of the first things you see when you look at the API.

@JuliaKukulies JuliaKukulies added good first issue An ideal issue for new contributors to address Low Priority This issue does not need addressing until a future update labels Nov 14, 2023
@w-k-jones
Copy link
Member

I agree, this also sticks out to me when checking the API reference! Best practice would be to make the default value None and then create the array inside the function, rather than have a mutable default keyword value

@JuliaKukulies JuliaKukulies added this to the Version 1.5.x milestone Nov 21, 2023
@martha889
Copy link

Hi. I would like to work on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue An ideal issue for new contributors to address Low Priority This issue does not need addressing until a future update
Projects
None yet
Development

No branches or pull requests

5 participants