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.

Sign up for GitHub

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

DOC: Improve np.histogram docs #25404

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cc0eaf0
DOC: improve weights description
TheHawz Dec 16, 2023
e59ac4f
DOC: fix code-snippet format
TheHawz Dec 16, 2023
58f3233
DOC: correct feedback
TheHawz Dec 18, 2023
a812ba8
DOC: remove the rest of the double quotes
TheHawz Dec 18, 2023
e7acf83
DOC: fix typo
TheHawz Dec 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
DOC: remove the rest of the double quotes
  • Loading branch information
@TheHawz
TheHawz authored Dec 18, 2023
commit a812ba8ae4792c693b847b1b0aff90744d78d3a8
8 changes: 4 additions & 4 deletions numpy/lib/_histograms_impl.py
View file
Open in desktop 8000
Original file line number Diff line number Diff line change
Expand Up @@ -714,8 +714,8 @@ def histogram(a, bins=10, range=None, density=None, weights=None):
Please note that the ``dtype`` of `weights` will dictate the
``dtype`` of the returned accumulator (`hist`).
density : bool, optional
If ``False``, the result will contain the number of samples in
each bin. If ``True``, the result is the value of the
If `False`, the result will contain the number of samples in
each bin. If `True`, the result is the value of the
probability *density* function at the bin, normalized such that
the *integral* over the range is 1. Note that the sum of the
histogram values will not be equal to 1 unless bins of unity
Expand All @@ -724,7 +724,7 @@ def histogram(a, bins=10, range=None, density=None, weights=None):
Returns
-------
hist : array
The values of the histogram. See ``density`` and ``weights`` for a
The values of the histogram. See `density` and `weights` for a
description of the possible semantics.
bin_edges : array of dtype float
Return the bin edges ``(length(hist)+1)``.
Expand All @@ -737,7 +737,7 @@ def histogram(a, bins=10, range=None, density=None, weights=None):
Notes
-----
All but the last (righthand-most) bin is half-open. In other words,
if ``bins`` is::
if `bins` is::

[1, 2, 3, 4]

Expand Down
2932
0