diff options
author | Charles Harris <charlesr.harris@gmail.com> | 2018-06-18 14:50:17 -0600 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-06-18 14:50:17 -0600 |
commit | 030f46d2091defa7a950b5a9ee88d813a9c1f93c (patch) | |
tree | de4963f316c827054a431baed92b440b30545327 /numpy/lib | |
parent | 44cfca844f043722906a9b2932a4ba03dce15c75 (diff) | |
parent | ba237a04b9e9b3d3aef0b342be52c5ee08101825 (diff) | |
download | numpy-030f46d2091defa7a950b5a9ee88d813a9c1f93c.tar.gz |
Merge pull request #11371 from eric-wieser/clarify_bin_order
DOC: Clarify requirement that histogram bins are monotonic.
Diffstat (limited to 'numpy/lib')
-rw-r--r-- | numpy/lib/histograms.py | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/numpy/lib/histograms.py b/numpy/lib/histograms.py index b7d9c4406..337957dd5 100644 --- a/numpy/lib/histograms.py +++ b/numpy/lib/histograms.py @@ -572,8 +572,8 @@ def histogram(a, bins=10, range=None, normed=None, weights=None, bins : int or sequence of scalars or str, optional If `bins` is an int, it defines the number of equal-width bins in the given range (10, by default). If `bins` is a - sequence, it defines the bin edges, including the rightmost - edge, allowing for non-uniform bin widths. + sequence, it defines a monotonically increasing array of bin edges, + including the rightmost edge, allowing for non-uniform bin widths. .. versionadded:: 1.11.0 @@ -833,7 +833,8 @@ def histogramdd(sample, bins=10, range=None, normed=False, weights=None): bins : sequence or int, optional The bin specification: - * A sequence of arrays describing the bin edges along each dimension. + * A sequence of arrays describing the monotonically increasing bin + edges along each dimension. * The number of bins for each dimension (nx, ny, ... =bins) * The number of bins for all dimensions (nx=ny=...=bins). |