diff options
author | Charles Harris <charlesr.harris@gmail.com> | 2014-07-27 13:23:17 -0500 |
---|---|---|
committer | Charles Harris <charlesr.harris@gmail.com> | 2014-07-27 13:23:17 -0500 |
commit | 656cf247e531c1ebfb69e864e00620b10082b120 (patch) | |
tree | da9b09ea7d81664f43f4f4160c502ed1c0c365d1 /doc | |
parent | 9ae5b5fab9f0c04c31c5d4b67d00c3cc79062731 (diff) | |
parent | 638e627c813590a91514b255aeb13a34dc2ac51e (diff) | |
download | numpy-656cf247e531c1ebfb69e864e00620b10082b120.tar.gz |
Merge pull request #4905 from juliantaylor/doc-update
documentation updates
Diffstat (limited to 'doc')
-rw-r--r-- | doc/HOWTO_DOCUMENT.rst.txt | 12 | ||||
-rw-r--r-- | doc/release/1.9.0-notes.rst | 7 | ||||
-rw-r--r-- | doc/source/reference/c-api.types-and-structures.rst | 2 | ||||
-rw-r--r-- | doc/source/reference/routines.array-manipulation.rst | 2 | ||||
-rw-r--r-- | doc/source/reference/routines.ma.rst | 3 | ||||
-rw-r--r-- | doc/source/reference/routines.maskna.rst | 11 |
6 files changed, 19 insertions, 18 deletions
diff --git a/doc/HOWTO_DOCUMENT.rst.txt b/doc/HOWTO_DOCUMENT.rst.txt index 2854b6b90..650f7d35c 100644 --- a/doc/HOWTO_DOCUMENT.rst.txt +++ b/doc/HOWTO_DOCUMENT.rst.txt @@ -30,14 +30,14 @@ A Guide to NumPy/SciPy Documentation Overview -------- -In general, we follow the standard Python style conventions as described here: - * `Style Guide for C Code <http://www.python.org/peps/pep-0007.html>`_ - * `Style Guide for Python Code <http://www.python.org/peps/pep-0008.html>`_ - * `Docstring Conventions <http://www.python.org/peps/pep-0257.html>`_ +We mostly follow the standard Python style conventions as described here: + * `Style Guide for C Code <http://python.org/dev/peps/pep-0007/>`_ + * `Style Guide for Python Code <http://python.org/dev/peps/pep-0008/>`_ + * `Docstring Conventions <http://python.org/dev/peps/pep-0257/>`_ Additional PEPs of interest regarding documentation of code: - * `Docstring Processing Framework <http://www.python.org/peps/pep-0256.html>`_ - * `Docutils Design Specification <http://www.python.org/peps/pep-0258.html>`_ + * `Docstring Processing Framework <http://python.org/dev/peps/pep-0256/>`_ + * `Docutils Design Specification <http://python.org/dev/peps/pep-0258/>`_ Use a code checker: * `pylint <http://www.logilab.org/857>`_ diff --git a/doc/release/1.9.0-notes.rst b/doc/release/1.9.0-notes.rst index 8d6308046..89acd353e 100644 --- a/doc/release/1.9.0-notes.rst +++ b/doc/release/1.9.0-notes.rst @@ -35,6 +35,8 @@ Future Changes * String version checks will break because, e.g., '1.9' > '1.10' is True. A NumpyVersion class has been added that can be used for such comparisons. * The diagonal and diag functions will return writeable views in 1.10.0 +* The `S` and/or `a` dtypes may be changed to represent Python strings + instead of bytes, in Python 3 these two types are very different. Compatibility notes @@ -176,6 +178,11 @@ introduced in advanced indexing operations: * Indexing with more then one ellipsis (``...``) is deprecated. +Non-integer reduction axis indexes are deprecated +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Non-integer axis indexes to reduction ufuncs like `add.reduce` or `sum` are +deprecated. + ``promote_types`` and string dtype ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ``promote_types`` function now returns a valid string length when given an diff --git a/doc/source/reference/c-api.types-and-structures.rst b/doc/source/reference/c-api.types-and-structures.rst index 4e32ab7be..95272c151 100644 --- a/doc/source/reference/c-api.types-and-structures.rst +++ b/doc/source/reference/c-api.types-and-structures.rst @@ -244,7 +244,7 @@ PyArrayDescr_Type Indicates that items of this data-type must be reference counted (using :cfunc:`Py_INCREF` and :cfunc:`Py_DECREF` ). - .. cvar:: NPY_ITEM_LISTPICKLE + .. cvar:: NPY_LIST_PICKLE Indicates arrays of this data-type must be converted to a list before pickling. diff --git a/doc/source/reference/routines.array-manipulation.rst b/doc/source/reference/routines.array-manipulation.rst index ca97bb479..81af0a315 100644 --- a/doc/source/reference/routines.array-manipulation.rst +++ b/doc/source/reference/routines.array-manipulation.rst @@ -54,6 +54,8 @@ Changing kind of array asmatrix asfarray asfortranarray + ascontiguousarray + asarray_chkfinite asscalar require diff --git a/doc/source/reference/routines.ma.rst b/doc/source/reference/routines.ma.rst index 5cb38e83f..66bcb1f1c 100644 --- a/doc/source/reference/routines.ma.rst +++ b/doc/source/reference/routines.ma.rst @@ -65,6 +65,8 @@ Inspecting the array ma.nonzero ma.shape ma.size + ma.is_masked + ma.is_mask ma.MaskedArray.data ma.MaskedArray.mask @@ -141,6 +143,7 @@ Joining arrays ma.column_stack ma.concatenate + ma.append ma.dstack ma.hstack ma.vstack diff --git a/doc/source/reference/routines.maskna.rst b/doc/source/reference/routines.maskna.rst deleted file mode 100644 index 2910acbac..000000000 --- a/doc/source/reference/routines.maskna.rst +++ /dev/null @@ -1,11 +0,0 @@ -NA-Masked Array Routines -======================== - -.. currentmodule:: numpy - -NA Values ---------- -.. autosummary:: - :toctree: generated/ - - isna |