diff options
author | Matti Picus <matti.picus@gmail.com> | 2019-01-23 13:26:44 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-01-23 13:26:44 +0200 |
commit | 9c98662ee2f7daca3f9fae9d5144a9a8d3cabe8c (patch) | |
tree | bc35cb371aec8ea12074aedb85eed4546b33c5b9 /doc | |
parent | f8058c81220565d0837a4331fbec7aa8dce5aaa9 (diff) | |
parent | 6c21238ac334e916fd4c4c77c3cea4224e33cf3e (diff) | |
download | numpy-9c98662ee2f7daca3f9fae9d5144a9a8d3cabe8c.tar.gz |
Merge pull request #12818 from mattip/doc-warnings
DOC: remove python2-only methods, small cleanups
Diffstat (limited to 'doc')
-rw-r--r-- | doc/C_STYLE_GUIDE.rst.txt | 2 | ||||
-rw-r--r-- | doc/DISTUTILS.rst.txt | 2 | ||||
-rw-r--r-- | doc/source/reference/arrays.ndarray.rst | 16 | ||||
-rw-r--r-- | doc/source/reference/maskedarray.baseclass.rst | 5 | ||||
-rw-r--r-- | doc/source/reference/routines.other.rst | 8 |
5 files changed, 9 insertions, 24 deletions
diff --git a/doc/C_STYLE_GUIDE.rst.txt b/doc/C_STYLE_GUIDE.rst.txt index a5726f16f..f68abaf7c 100644 --- a/doc/C_STYLE_GUIDE.rst.txt +++ b/doc/C_STYLE_GUIDE.rst.txt @@ -201,7 +201,7 @@ Naming conventions In the future the names should be of the form ``Npy*_PublicFunction``, where the star is something appropriate. -* Public Macros should have a NPY_ prefix and then use upper case, +* Public Macros should have a ``NPY_`` prefix and then use upper case, for example, ``NPY_DOUBLE``. * Private functions should be lower case with underscores, for example: diff --git a/doc/DISTUTILS.rst.txt b/doc/DISTUTILS.rst.txt index c027afff2..515fc871b 100644 --- a/doc/DISTUTILS.rst.txt +++ b/doc/DISTUTILS.rst.txt @@ -427,7 +427,7 @@ Extra features in NumPy Distutils ''''''''''''''''''''''''''''''''' Specifying config_fc options for libraries in setup.py script ------------------------------------------------------------- +------------------------------------------------------------- It is possible to specify config_fc options in setup.py scripts. For example, using diff --git a/doc/source/reference/arrays.ndarray.rst b/doc/source/reference/arrays.ndarray.rst index 306d22f43..19a8bc7b8 100644 --- a/doc/source/reference/arrays.ndarray.rst +++ b/doc/source/reference/arrays.ndarray.rst @@ -461,12 +461,12 @@ Truth value of an array (:func:`bool()`): .. autosummary:: :toctree: generated/ - ndarray.__nonzero__ + ndarray.__bool__ .. note:: Truth-value testing of an array invokes - :meth:`ndarray.__nonzero__`, which raises an error if the number of + :meth:`ndarray.__bool__`, which raises an error if the number of elements in the array is larger than 1, because the truth value of such arrays is ambiguous. Use :meth:`.any() <ndarray.any>` and :meth:`.all() <ndarray.all>` instead to be clear about what is meant @@ -492,7 +492,6 @@ Arithmetic: ndarray.__add__ ndarray.__sub__ ndarray.__mul__ - ndarray.__div__ ndarray.__truediv__ ndarray.__floordiv__ ndarray.__mod__ @@ -527,7 +526,6 @@ Arithmetic, in-place: ndarray.__iadd__ ndarray.__isub__ ndarray.__imul__ - ndarray.__idiv__ ndarray.__itruediv__ ndarray.__ifloordiv__ ndarray.__imod__ @@ -597,19 +595,17 @@ Container customization: (see :ref:`Indexing <arrays.indexing>`) ndarray.__setitem__ ndarray.__contains__ -Conversion; the operations :func:`complex()`, :func:`int()`, -:func:`long()`, :func:`float()`, :func:`oct()`, and -:func:`hex()`. They work only on arrays that have one element in them +Conversion; the operations :func:`int()`, :func:`float()` and +:func:`complex()`. +. They work only on arrays that have one element in them and return the appropriate scalar. .. autosummary:: :toctree: generated/ ndarray.__int__ - ndarray.__long__ ndarray.__float__ - ndarray.__oct__ - ndarray.__hex__ + ndarray.__complex__ String representations: diff --git a/doc/source/reference/maskedarray.baseclass.rst b/doc/source/reference/maskedarray.baseclass.rst index 427ad1536..17a0a940d 100644 --- a/doc/source/reference/maskedarray.baseclass.rst +++ b/doc/source/reference/maskedarray.baseclass.rst @@ -184,10 +184,8 @@ Conversion :toctree: generated/ MaskedArray.__float__ - MaskedArray.__hex__ MaskedArray.__int__ MaskedArray.__long__ - MaskedArray.__oct__ MaskedArray.view MaskedArray.astype @@ -311,7 +309,7 @@ Truth value of an array (:func:`bool()`): .. autosummary:: :toctree: generated/ - MaskedArray.__nonzero__ + MaskedArray.__bool__ Arithmetic: @@ -328,7 +326,6 @@ Arithmetic: MaskedArray.__mul__ MaskedArray.__rmul__ MaskedArray.__div__ - MaskedArray.__rdiv__ MaskedArray.__truediv__ MaskedArray.__rtruediv__ MaskedArray.__floordiv__ diff --git a/doc/source/reference/routines.other.rst b/doc/source/reference/routines.other.rst index 45b9ac3d9..0a3677904 100644 --- a/doc/source/reference/routines.other.rst +++ b/doc/source/reference/routines.other.rst @@ -5,14 +5,6 @@ Miscellaneous routines .. currentmodule:: numpy -Buffer objects --------------- -.. autosummary:: - :toctree: generated/ - - getbuffer - newbuffer - Performance tuning ------------------ .. autosummary:: |