summaryrefslogtreecommitdiff
path: root/doc/neps
diff options
context:
space:
mode:
authorRalf Gommers <ralf.gommers@gmail.com>2018-09-22 23:41:58 -0400
committerRalf Gommers <ralf.gommers@gmail.com>2018-09-22 23:42:45 -0400
commitd23a73bf23acfc3ed675ba8c2d28aac275a8fef7 (patch)
tree40fd0fb0d0d82345b0cc2508029c5a49d52a3ca7 /doc/neps
parent1c0ebd808ede34d384a44ed19093afc109ba0cd8 (diff)
downloadnumpy-d23a73bf23acfc3ed675ba8c2d28aac275a8fef7.tar.gz
DOC: MAINT: address comments @eric-wieser on NEP 24-26 PR. Bump copyright year
[ci skip]
Diffstat (limited to 'doc/neps')
-rw-r--r--doc/neps/conf.py2
-rw-r--r--doc/neps/nep-0026-missing-data-summary.rst27
2 files changed, 16 insertions, 13 deletions
diff --git a/doc/neps/conf.py b/doc/neps/conf.py
index bd7503781..6eed7d0c9 100644
--- a/doc/neps/conf.py
+++ b/doc/neps/conf.py
@@ -46,7 +46,7 @@ master_doc = 'index'
# General information about the project.
project = u'NumPy Enhancement Proposals'
-copyright = u'2017, NumPy Developers'
+copyright = u'2017-2018, NumPy Developers'
author = u'NumPy Developers'
# The version info for the project you're documenting, acts as replacement for
diff --git a/doc/neps/nep-0026-missing-data-summary.rst b/doc/neps/nep-0026-missing-data-summary.rst
index 6f7fd0fa1..e99138cdd 100644
--- a/doc/neps/nep-0026-missing-data-summary.rst
+++ b/doc/neps/nep-0026-missing-data-summary.rst
@@ -7,8 +7,9 @@ NEP 26 — Summary of Missing Data NEPs and discussion
:Type: Standards Track
:Created: 2012-04-22
-*Context: this NEP was written as summary of the large number of discussions
-and proposals (NEP 12, NEP 24, NEP 25), regarding missing data functionality.*
+*Context*: this NEP was written as summary of the large number of discussions
+and proposals (`NEP 12`_, `NEP 24`_, `NEP 25`_), regarding missing data
+functionality.
The debate about how NumPy should handle missing data, a subject with
many preexisting approaches, requirements, and conventions, has been long and
@@ -348,11 +349,9 @@ dtypes can arrange for certain bitpatterns to be given NA semantics.
One option is to copy numpy.ma closely, but with a more optimized
implementation. (Or to simply optimize the existing implementation.)
-One option is that described in the NEP_, for which an implementation
+One option is that described in `NEP 12`_, for which an implementation
of mask-based missing data exists. This system is roughly:
-.. _NEP: https://github.com/numpy/numpy/blob/master/doc/neps/nep-0012-missing-data.rst
-
* There is both bitpattern and mask-based missing data, and both
have identical interoperable NA semantics.
* Masks are modified by assigning np.NA or values to array elements.
@@ -365,14 +364,12 @@ of mask-based missing data exists. This system is roughly:
a bitpattern NA to an array which supports both requires accessing
the data by "peeking under the mask".
-Another option is that described in the alterNEP_, which is to implement
+Another option is that described in `NEP 24`_, which is to implement
bitpattern dtypes with NA semantics for the "statistical missing data"
use case, and to also implement a totally independent API for masked
arrays with ignore semantics and all mask manipulation done explicitly
through a .mask attribute.
-.. _alterNEP: https://gist.github.com/njsmith/1056379
-
Another option would be to define a minimalist aligned array container
that holds multiple arrays and that can be used to pass them around
together. It would support indexing (to help with the common problem
@@ -707,14 +704,14 @@ risk of reducing developer contribution.
References and Footnotes
------------------------
-NEP 12 describes Mark's NA-semantics/mask implementation/view based mask
+`NEP 12`_ describes Mark's NA-semantics/mask implementation/view based mask
handling API.
-NEP 24 ("the alterNEP") was Nathaniel's initial attempt at separating MISSING
+`NEP 24`_ ("the alterNEP") was Nathaniel's initial attempt at separating MISSING
and IGNORED handling into bit-patterns versus masks, though there's a bunch
he would change about the proposal at this point.
-NEP 25 ("miniNEP 2") was a later attempt by Nathaniel to sketch out an
+`NEP 25`_ ("miniNEP 2") was a later attempt by Nathaniel to sketch out an
implementation strategy for NA dtypes.
A further discussion overview page can be found at:
@@ -724,4 +721,10 @@ https://github.com/njsmith/numpy/wiki/NA-discussion-status
Copyright
---------
-This document has been placed in the public domain. \ No newline at end of file
+This document has been placed in the public domain.
+
+.. _NEP 12: http://www.numpy.org/neps/nep-0012-missing-data.html
+
+.. _NEP 24: http://www.numpy.org/neps/nep-0024-missing-data-2.html
+
+.. _NEP 25: http://www.numpy.org/neps/nep-0025-missing-data-3.html