Skip to content

Commit

Permalink
DOC: link to the npy-format NEP in numpy.npyio docs. Closes numpygh-4523
Browse files Browse the repository at this point in the history
.

[ci skip]
  • Loading branch information
rgommers committed Jan 2, 2015
1 parent c852f59 commit 20bc2eb
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
7 changes: 5 additions & 2 deletions doc/source/reference/routines.io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Input and output

.. currentmodule:: numpy

NPZ files
---------
Numpy binary files (NPY, NPZ)
-----------------------------
.. autosummary::
:toctree: generated/

Expand All @@ -13,6 +13,9 @@ NPZ files
savez
savez_compressed

The format of these binary file types is documented in
http://docs.scipy.org/doc/numpy/neps/npy-format.html

Text files
----------
.. autosummary::
Expand Down
7 changes: 5 additions & 2 deletions numpy/lib/npyio.py
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,8 @@ def save(file, arr):
Notes
-----
For a description of the ``.npy`` format, see the module docstring
of `numpy.lib.format`.
of `numpy.lib.format` or the Numpy Enhancement Proposal
http://docs.scipy.org/doc/numpy/neps/npy-format.html
Examples
--------
Expand Down Expand Up @@ -504,7 +505,9 @@ 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 `format`.
description of the ``.npy`` format, see `numpy.lib.format` or the
Numpy Enhancement Proposal
http://docs.scipy.org/doc/numpy/neps/npy-format.html
When opening the saved ``.npz`` file with `load` a `NpzFile` object is
returned. This is a dictionary-like object which can be queried for
Expand Down

0 comments on commit 20bc2eb

Please sign in to comment.