From d416eda11014a689bb88c96fac33374b91251d11 Mon Sep 17 00:00:00 2001 From: mattip Date: Wed, 13 Jun 2018 16:08:23 -0700 Subject: DOC: quiet warnings about "document not in any toctree" --- doc/source/reference/routines.numarray.rst | 2 ++ doc/source/reference/routines.oldnumeric.rst | 2 ++ 2 files changed, 4 insertions(+) (limited to 'doc/source/reference') diff --git a/doc/source/reference/routines.numarray.rst b/doc/source/reference/routines.numarray.rst index 9e84f49b9..97251d293 100644 --- a/doc/source/reference/routines.numarray.rst +++ b/doc/source/reference/routines.numarray.rst @@ -1,3 +1,5 @@ +:orphan: + ********************** Numarray compatibility ********************** diff --git a/doc/source/reference/routines.oldnumeric.rst b/doc/source/reference/routines.oldnumeric.rst index 2120fc69e..1a6218aac 100644 --- a/doc/source/reference/routines.oldnumeric.rst +++ b/doc/source/reference/routines.oldnumeric.rst @@ -1,3 +1,5 @@ +:orphan: + ************************* Old Numeric compatibility ************************* -- cgit v1.2.1 From d4b43bb148678516c11d8a0b0cae9b53635f9ee0 Mon Sep 17 00:00:00 2001 From: mattip Date: Fri, 15 Jun 2018 10:51:39 -0700 Subject: DOC: typos, small fixes --- doc/source/reference/arrays.indexing.rst | 5 +++-- doc/source/reference/c-api.coremath.rst | 2 +- doc/source/reference/c-api.ufunc.rst | 20 +++++++++----------- 3 files changed, 13 insertions(+), 14 deletions(-) (limited to 'doc/source/reference') diff --git a/doc/source/reference/arrays.indexing.rst b/doc/source/reference/arrays.indexing.rst index ba1bfd312..62d36e28c 100644 --- a/doc/source/reference/arrays.indexing.rst +++ b/doc/source/reference/arrays.indexing.rst @@ -173,6 +173,7 @@ concepts to remember include: of arbitrary dimension. .. data:: newaxis + :noindex: The :const:`newaxis` object can be used in all slicing operations to create an axis of length one. :const:`newaxis` is an alias for @@ -287,7 +288,7 @@ understood with an example. Combining advanced and basic indexing """"""""""""""""""""""""""""""""""""" -When there is at least one slice (``:``), ellipsis (``...``) or ``np.newaxis`` +When there is at least one slice (``:``), ellipsis (``...``) or :const:`newaxis` in the index (or the array has more dimensions than there are advanced indexes), then the behaviour can be more complicated. It is like concatenating the indexing result for each advanced index element @@ -310,7 +311,7 @@ the subspace defined by the basic indexing (excluding integers) and the subspace from the advanced indexing part. Two cases of index combination need to be distinguished: -* The advanced indexes are separated by a slice, ellipsis or newaxis. +* The advanced indexes are separated by a slice, :const:`Ellipsis` or :const:`newaxis`. For example ``x[arr1, :, arr2]``. * The advanced indexes are all next to each other. For example ``x[..., arr1, arr2, :]`` but *not* ``x[arr1, :, 1]`` diff --git a/doc/source/reference/c-api.coremath.rst b/doc/source/reference/c-api.coremath.rst index ad92235da..ba1c61e8e 100644 --- a/doc/source/reference/c-api.coremath.rst +++ b/doc/source/reference/c-api.coremath.rst @@ -222,7 +222,7 @@ Those can be useful for precise floating point comparison. Returns the previous status mask. .. versionadded:: 1.15.0 -n + Complex functions ~~~~~~~~~~~~~~~~~ diff --git a/doc/source/reference/c-api.ufunc.rst b/doc/source/reference/c-api.ufunc.rst index 02a35cf56..8c2554a9e 100644 --- a/doc/source/reference/c-api.ufunc.rst +++ b/doc/source/reference/c-api.ufunc.rst @@ -94,19 +94,16 @@ Functions :param types: Length ``(nin + nout) * ntypes`` array of ``char`` encoding the - :ref:`PyArray_Descr.type_num` (built-in only) that the corresponding + `numpy.dtype.num` (built-in only) that the corresponding function in the ``func`` array accepts. For instance, for a comparison ufunc with three ``ntypes``, two ``nin`` and one ``nout``, where the - first function accepts :ref:`npy_int32` and the the second - :ref:`npy_int64`, with both returning :ref:`npy_bool`, ``types`` would + first function accepts `numpy.int32` and the the second + `numpy.int64`, with both returning `numpy.bool_`, ``types`` would be ``(char[]) {5, 5, 0, 7, 7, 0}`` since ``NPY_INT32`` is 5, - ``NPY_INT64`` is 7, and ``NPY_BOOL`` is 0 (on the python side, these - are exposed via :ref:`dtype.num`, i.e., for the example here, - ``dtype(np.int32).num``, ``dtype(np.int64).num``, and - ``dtype(np.bool_).num``, resp.). + ``NPY_INT64`` is 7, and ``NPY_BOOL`` is 0. - :ref:`casting-rules` will be used at runtime to find the first - ``func`` callable by the input/output provided. + :ref:`ufuncs.casting` will be used at runtime to find the first + ``func`` callable by the input/output provided. :param ntypes: How many different data-type-specific functions the ufunc has implemented. @@ -121,8 +118,9 @@ Functions The name for the ufunc. Specifying a name of 'add' or 'multiply' enables a special behavior for integer-typed reductions when no dtype is given. If the input type is an - integer (or boolean) data type smaller than the size of the int_ - data type, it will be internally upcast to the int_ (or uint) + integer (or boolean) data type smaller than the size of the + `numpy.int_` data type, it will be internally upcast to the + `numpy.int_` (or `numpy.uint`) data type. :param doc: -- cgit v1.2.1 From 6d601e51cdce8420b4bea383ee4a17ae8ff2969c Mon Sep 17 00:00:00 2001 From: mattip Date: Sun, 24 Jun 2018 16:27:37 -0700 Subject: fixes from review --- doc/source/reference/routines.numarray.rst | 7 ------- doc/source/reference/routines.oldnumeric.rst | 9 --------- 2 files changed, 16 deletions(-) delete mode 100644 doc/source/reference/routines.numarray.rst delete mode 100644 doc/source/reference/routines.oldnumeric.rst (limited to 'doc/source/reference') diff --git a/doc/source/reference/routines.numarray.rst b/doc/source/reference/routines.numarray.rst deleted file mode 100644 index 97251d293..000000000 --- a/doc/source/reference/routines.numarray.rst +++ /dev/null @@ -1,7 +0,0 @@ -:orphan: - -********************** -Numarray compatibility -********************** - -The numarray module was removed in NumPy 1.9.0. diff --git a/doc/source/reference/routines.oldnumeric.rst b/doc/source/reference/routines.oldnumeric.rst deleted file mode 100644 index 1a6218aac..000000000 --- a/doc/source/reference/routines.oldnumeric.rst +++ /dev/null @@ -1,9 +0,0 @@ -:orphan: - -************************* -Old Numeric compatibility -************************* - -.. currentmodule:: numpy - -The oldnumeric module was removed in NumPy 1.9.0. -- cgit v1.2.1