summaryrefslogtreecommitdiff
path: root/numpy/lib/format.py
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2018-05-13 08:36:08 -0600
committerGitHub <noreply@github.com>2018-05-13 08:36:08 -0600
commit896363f962c2c7f2275b38407666525fc344e4d8 (patch)
treee8e8a0e3ed4de8fa6550b12d783a4098b1264728 /numpy/lib/format.py
parentb4c42a553f5954e58ab2aef5fe33ceb5fc970e0a (diff)
parent85282a5dac927ed731655e0a58fb67d2483f18b9 (diff)
downloadnumpy-896363f962c2c7f2275b38407666525fc344e4d8.tar.gz
Merge pull request #11082 from mattip/fix-11080
DOC: link to updated module docstring, not NEP
Diffstat (limited to 'numpy/lib/format.py')
-rw-r--r--numpy/lib/format.py11
1 files changed, 8 insertions, 3 deletions
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