summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMatti Picus <matti.picus@gmail.com>2019-04-10 08:36:53 +0300
committerGitHub <noreply@github.com>2019-04-10 08:36:53 +0300
commit3837444977aaa207c0ce031ad0167ea0e2400506 (patch)
tree07a44499a7d1d31422cc965a9b73e10528a58af7 /doc
parentc5413e780a90c0f636d563b0d31ad812131aac0c (diff)
parentd6a8cabd725e93a1dcfc03f0b4154dd96fd4ce8f (diff)
downloadnumpy-3837444977aaa207c0ce031ad0167ea0e2400506.tar.gz
Merge branch 'master' into isfinite-datetime
Diffstat (limited to 'doc')
-rw-r--r--doc/release/1.17.0-notes.rst11
-rw-r--r--doc/source/dev/development_environment.rst3
-rw-r--r--doc/source/docs/howto_build_docs.rst2
-rw-r--r--doc/source/reference/c-api.types-and-structures.rst28
m---------doc/sphinxext0
5 files changed, 38 insertions, 6 deletions
diff --git a/doc/release/1.17.0-notes.rst b/doc/release/1.17.0-notes.rst
index 7777c8f05..a11c008ed 100644
--- a/doc/release/1.17.0-notes.rst
+++ b/doc/release/1.17.0-notes.rst
@@ -197,11 +197,18 @@ The boolean and integer types are incapable of storing ``np.nan`` and ``np.inf``
which allows us to provide specialized ufuncs that are up to 250x faster than the current
approach.
-``np.isfinite`` ufunc supports ``datetime64`` and ``timedelta64`` types
------------------------------------------------------------------------
+``np.isfinite`` supports ``datetime64`` and ``timedelta64`` types
+-----------------------------------------------------------------
Previously, `np.isfinite` used to raise a ``TypeError`` on being used on these
two types.
+New keywords added to ``np.nan_to_num``
+---------------------------------------
+``np.nan_to_num`` now accepts keywords ``nan``, ``posinf`` and ``neginf`` allowing the
+user to define the value to replace the ``nan``, positive and negative ``np.inf`` values
+respectively.
+
+
Changes
=======
diff --git a/doc/source/dev/development_environment.rst b/doc/source/dev/development_environment.rst
index f9b438bfd..445ce3204 100644
--- a/doc/source/dev/development_environment.rst
+++ b/doc/source/dev/development_environment.rst
@@ -127,6 +127,9 @@ the interpreter, tests can be run like this::
>>> np.test('full') # Also run tests marked as slow
>>> np.test('full', verbose=2) # Additionally print test name/file
+ An example of a successful test :
+ ``4686 passed, 362 skipped, 9 xfailed, 5 warnings in 213.99 seconds``
+
Or a similar way from the command line::
$ python -c "import numpy as np; np.test()"
diff --git a/doc/source/docs/howto_build_docs.rst b/doc/source/docs/howto_build_docs.rst
index cdf490c37..98d1b88ba 100644
--- a/doc/source/docs/howto_build_docs.rst
+++ b/doc/source/docs/howto_build_docs.rst
@@ -5,7 +5,7 @@ Building the NumPy API and reference docs
=========================================
We currently use Sphinx_ for generating the API and reference
-documentation for NumPy. You will need Sphinx 1.0.1 or newer.
+documentation for NumPy. You will need Sphinx 1.8.3 or newer.
If you only want to get the documentation, note that pre-built
versions can be found at
diff --git a/doc/source/reference/c-api.types-and-structures.rst b/doc/source/reference/c-api.types-and-structures.rst
index f04d65ee1..f411ebc44 100644
--- a/doc/source/reference/c-api.types-and-structures.rst
+++ b/doc/source/reference/c-api.types-and-structures.rst
@@ -203,14 +203,17 @@ PyArrayDescr_Type
char kind;
char type;
char byteorder;
- char unused;
- int flags;
+ char flags;
int type_num;
int elsize;
int alignment;
PyArray_ArrayDescr *subarray;
PyObject *fields;
+ PyObject *names;
PyArray_ArrFuncs *f;
+ PyObject *metadata;
+ NpyAuxData *c_metadata;
+ npy_hash_t hash;
} PyArray_Descr;
.. c:member:: PyTypeObject *PyArray_Descr.typeobj
@@ -242,7 +245,7 @@ PyArrayDescr_Type
endian), '=' (native), '\|' (irrelevant, ignore). All builtin data-
types have byteorder '='.
-.. c:member:: int PyArray_Descr.flags
+.. c:member:: char PyArray_Descr.flags
A data-type bit-flag that determines if the data-type exhibits object-
array like behavior. Each bit in this member is a flag which are named
@@ -377,6 +380,11 @@ PyArrayDescr_Type
normally a Python string. These tuples are placed in this
dictionary keyed by name (and also title if given).
+.. c:member:: PyObject *PyArray_Descr.names
+
+ An ordered tuple of field names. It is NULL if no field is
+ defined.
+
.. c:member:: PyArray_ArrFuncs *PyArray_Descr.f
A pointer to a structure containing functions that the type needs
@@ -384,6 +392,20 @@ PyArrayDescr_Type
thing as the universal functions (ufuncs) described later. Their
signatures can vary arbitrarily.
+.. c:member:: PyObject *PyArray_Descr.metadata
+
+ Metadata about this dtype.
+
+.. c:member:: NpyAuxData *PyArray_Descr.c_metadata
+
+ Metadata specific to the C implementation
+ of the particular dtype. Added for NumPy 1.7.0.
+
+.. c:member:: Npy_hash_t *PyArray_Descr.hash
+
+ Currently unused. Reserved for future use in caching
+ hash values.
+
.. c:type:: PyArray_ArrFuncs
Functions implementing internal features. Not all of these
diff --git a/doc/sphinxext b/doc/sphinxext
-Subproject e47b9404963ad2a75a11d167416038275c50d1c
+Subproject a482f66913c1079d7439770f0119b55376bb1b8