DOC: Improve np.histogram documentation #25403
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It must be ``text``and not `text` for inline code samples.
|
Thanks! I just want to note, however, that it is not unambiguous that "dictates the dtype" means that the accumulator dtype will become exactly the dtype of the weights – it could also mean that there is a mapping such as weights uint8 -> acc uint64, weights float -> acc double, ... that would be applied. (And that would make so much sense that people could expect that and thus read it into the new documentation sentence, I am afraid.) |
|
@hmeine that sounds reasonable - please feel free to propose wording updates in a PR! |
rossbar
pushed a commit
that referenced
this pull request
Jan 17, 2024
* DOC: unambiguous np.histogram dtype description As a follow-up of #25403, let's be more specific than "dictates the dtype" because that could still mean that there is a mapping applied such as weights uint8 -> acc uint64, weights float -> acc double, ... That would make so much sense that people could expect that and thus read it into the documentation, I am afraid.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improving
np.histogram's documentationIt 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
Skipping all CI because this is a documentation correction:
[skip ci]