8000 Merge pull request #5413 from rgommers/link-format-nep · numpy/numpy@3a9b333 · GitHub
[go: up one dir, main page]

Skip to content

Commit 3a9b333

Browse files
committed
Merge pull request #5413 from rgommers/link-format-nep
DOC: link to the npy-format NEP in numpy.npyio docs. Closes gh-4523.
2 parents a908924 + 20bc2eb commit 3a9b333

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

doc/source/reference/routines.io.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ Input and output
33

44
.. currentmodule:: numpy
55

6-
NPZ files
7-
---------
6+
Numpy binary files (NPY, NPZ)
7+
-----------------------------
88
.. autosummary::
99
:toctree: generated/
1010

@@ -13,6 +13,9 @@ NPZ files
1313
savez
1414
savez_compressed
1515

16+
The format of these binary file types is documented in
17+
http://docs.scipy.org/doc/numpy/neps/npy-format.html
18+
1619
Text files
1720
----------
1821
.. autosummary::

numpy/lib/npyio.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,8 @@ def save(file, arr):
433433
Notes
434434
-----
435435
For a description of the ``.npy`` format, see the module docstring
436-
of `numpy.lib.format`.
436+
of `numpy.lib.format` or the Numpy Enhancement Proposal
437+
http://docs.scipy.org/doc/numpy/neps/npy-format.html
437438
438439
Examples
439440
--------
@@ -504,7 +505,9 @@ def savez(file, *args, **kwds):
504505
The ``.npz`` file format is a zipped archive of files named after the
505506
variables they contain. The archive is not compressed and each file
506507
in the archive contains one variable in ``.npy`` format. For a
507-
description of the ``.npy`` format, see `format`.
508+
description of the ``.npy`` format, see `numpy.lib.format` or the
509+
Numpy Enhancement Proposal
510+
http://docs.scipy.org/doc/numpy/neps/npy-format.html
508511
509512
When opening the saved ``.npz`` file with `load` a `NpzFile` object is
510513
returned. This is a dictionary-like object which can be queried for

0 commit comments

Comments
 (0)
0