From ba237a04b9e9b3d3aef0b342be52c5ee08101825 Mon Sep 17 00:00:00 2001 From: Eric Wieser Date: Sun, 17 Jun 2018 19:38:27 -0700 Subject: DOC: Clarify requirement that histogram bins are monotonic. Close gh-631 --- numpy/lib/histograms.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'numpy/lib') diff --git a/numpy/lib/histograms.py b/numpy/lib/histograms.py index 2922b3a86..b7b6d4717 100644 --- a/numpy/lib/histograms.py +++ b/numpy/lib/histograms.py @@ -571,8 +571,8 @@ def histogram(a, bins=10, range=None, normed=False, 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 @@ -811,7 +811,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). -- cgit v1.2.1