8000 DOC: Improve ``np.histogram`` docs by TheHawz · Pull Request #25404 · numpy/numpy · GitHub
[go: up one dir, main page]

Skip to content

DOC: Improve np.histogram docs #25404

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

Merged
merged 5 commits into from
Dec 18, 2023
Merged

Conversation

TheHawz
Copy link
Contributor
@TheHawz TheHawz commented Dec 16, 2023

Improving np.histogram's documentation

It was not documented that the dtype of the output of np.histogram's depends on the dtype of the weights parameter.

Closes #25385
Closes #23681
Closes #16616

@charris charris changed the title Improve np.histogram docu DOC: Improve np.histogram docs Dec 16, 2023
Copy link
Contributor
@mdhaber mdhaber left a comment

Choose a reason for hiding this comment

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

According to the numpydoc Style guide, the existing uses of single backticks were correct throughout. (There are efforts to make these render as teletype, though, if that's what you were going for. CC @rossbar.)

Unless these were the cause of warnings due to name collisions (I know there have been issues with that recently, e.g. gh-24348), I'd suggest changing these back so the rest can be merged.

dtype can stay in double-backticks, since it's not a parameter of this function, or arguably NumPy docs have coined "dtype" as an English word, in which case it needs no stylization.

@TheHawz TheHawz requested a review from mdhaber December 18, 2023 08:40
@TheHawz
Copy link
Contributor Author
TheHawz commented Dec 18, 2023

Unless these were the cause of warnings due to name collisions (I know there have been issues with that recently, e.g. gh-24348), I'd suggest changing these back so the rest can be merged.

Thanks for the feedback!

Copy link
Contributor
@rossbar rossbar left a comment

Choose a reason for hiding this comment

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

Thanks @TheHawz !

@rossbar rossbar merged commit 8385ba3 into numpy:main Dec 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants
0