summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoseph Fox-Rabinovitz <jfoxrabinovitz@gmail.com>2016-03-14 23:06:46 -0400
committerJoseph Fox-Rabinovitz <jfoxrabinovitz@gmail.com>2016-03-16 05:49:37 -0400
commit8869c1ace77affefff75c8a772edb2983b68a015 (patch)
tree839c61a8bd82416f4b943486e16b139bec8b533a /doc
parent127eb9e7a4fb79668e62d1a50cf428fb7e7bf18e (diff)
downloadnumpy-8869c1ace77affefff75c8a772edb2983b68a015.tar.gz
DOC: Updated documentation to reflect changes to bin estimators.
Described ad nauseum the relationship between `range` parameter and bin estimation. Updated formulas for estimators now that they are returning bin widths.
Diffstat (limited to 'doc')
-rw-r--r--doc/release/1.12.0-notes.rst16
1 files changed, 9 insertions, 7 deletions
diff --git a/doc/release/1.12.0-notes.rst b/doc/release/1.12.0-notes.rst
index 38e5e4338..35ce3ae4a 100644
--- a/doc/release/1.12.0-notes.rst
+++ b/doc/release/1.12.0-notes.rst
@@ -128,15 +128,17 @@ but that can be overwritten by people making binary distributions of numpy.
Improvements
============
-*np.loadtxt* now supports a single integer as ``usecol`` argument
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``np.loadtxt`` now supports a single integer as ``usecol`` argument
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Instead of using ``usecol=(n,)`` to read the nth column of a file
it is now allowed to use ``usecol=n``. Also the error message is
more user friendly when a non-integer is passed as a column index.
-Additional estimators for ``histogram``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Added 'doane' and 'sqrt' estimators to ``histogram`` via the ``bins`` argument.
+Improved automated bin estimators for ``histogram``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Added 'doane' and 'sqrt' estimators to ``histogram`` via the ``bins``
+argument. Added support for range-restricted histograms with automated
+bin estimation.
``bitwise_and`` identity changed
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -157,8 +159,8 @@ Assignment of ndarray object's ``data`` attribute
Assigning the 'data' attribute is an inherently unsafe operation as pointed
out in gh-7083. Such a capability will be removed in the future.
-Unsafe int casting of the num attribute in linspace
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Unsafe int casting of the num attribute in ``linspace``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``np.linspace`` now raises DeprecationWarning when num cannot be safely
interpreted as an integer.