diff options
author | mattip <matti.picus@gmail.com> | 2018-05-13 11:09:05 +0300 |
---|---|---|
committer | mattip <matti.picus@gmail.com> | 2018-05-13 11:09:05 +0300 |
commit | 85282a5dac927ed731655e0a58fb67d2483f18b9 (patch) | |
tree | 577ce3314bebd9a9b0b58bd552102a1d67b276e9 | |
parent | 25a2d3079ffb9fd0df5e87639941e83d63cd480c (diff) | |
download | numpy-85282a5dac927ed731655e0a58fb67d2483f18b9.tar.gz |
DOC: link to updated module docstring, not NEP
-rw-r--r-- | doc/source/reference/routines.io.rst | 2 | ||||
-rw-r--r-- | numpy/lib/format.py | 11 | ||||
-rw-r--r-- | numpy/lib/npyio.py | 14 |
3 files changed, 14 insertions, 13 deletions
diff --git a/doc/source/reference/routines.io.rst b/doc/source/reference/routines.io.rst index 573498792..bbe3e8979 100644 --- a/doc/source/reference/routines.io.rst +++ b/doc/source/reference/routines.io.rst @@ -14,7 +14,7 @@ NumPy binary files (NPY, NPZ) savez_compressed The format of these binary file types is documented in -http://numpy.github.io/neps/npy-format.html +:py:mod:`numpy.lib.format` Text files ---------- diff --git a/numpy/lib/format.py b/numpy/lib/format.py index 363bb2101..afa154cc5 100644 --- a/numpy/lib/format.py +++ b/numpy/lib/format.py @@ -1,5 +1,8 @@ """ -Define a simple format for saving numpy arrays to disk with the full +Binary Serialization +==================== + +A simple format for saving numpy arrays to disk with the full information about them. The ``.npy`` format is the standard binary file format in NumPy for @@ -143,8 +146,10 @@ data HEADER_LEN." Notes ----- -The ``.npy`` format, including reasons for creating it and a comparison of -alternatives, is described fully in the "npy-format" NEP. +The ``.npy`` format, including motivation for creating it and a comparison of +alternatives, is described in the `"npy-format" NEP +<http://www.numpy.org/neps/nep-0001-npy-format.html>`_, however details have +evolved with time and this document is more current. """ from __future__ import division, absolute_import, print_function diff --git a/numpy/lib/npyio.py b/numpy/lib/npyio.py index 76cc07ff1..5d3c1e525 100644 --- a/numpy/lib/npyio.py +++ b/numpy/lib/npyio.py @@ -475,9 +475,7 @@ def save(file, arr, allow_pickle=True, fix_imports=True): Notes ----- - For a description of the ``.npy`` format, see the module docstring - of `numpy.lib.format` or the NumPy Enhancement Proposal - http://numpy.github.io/neps/npy-format.html + For a description of the ``.npy`` format, see :py:mod:`numpy.lib.format` Examples -------- @@ -561,9 +559,7 @@ def savez(file, *args, **kwds): The ``.npz`` file format is a zipped archive of files named after the variables they contain. The archive is not compressed and each file in the archive contains one variable in ``.npy`` format. For a - description of the ``.npy`` format, see `numpy.lib.format` or the - NumPy Enhancement Proposal - http://numpy.github.io/neps/npy-format.html + description of the ``.npy`` format, see :py:mod:`numpy.lib.format` When opening the saved ``.npz`` file with `load` a `NpzFile` object is returned. This is a dictionary-like object which can be queried for @@ -642,9 +638,9 @@ def savez_compressed(file, *args, **kwds): The ``.npz`` file format is a zipped archive of files named after the variables they contain. The archive is compressed with ``zipfile.ZIP_DEFLATED`` and each file in the archive contains one variable - in ``.npy`` format. For a description of the ``.npy`` format, see - `numpy.lib.format` or the NumPy Enhancement Proposal - http://numpy.github.io/neps/npy-format.html + in ``.npy`` format. For a description of the ``.npy`` format, see + :py:mod:`numpy.lib.format` + When opening the saved ``.npz`` file with `load` a `NpzFile` object is returned. This is a dictionary-like object which can be queried for |