summaryrefslogtreecommitdiff
path: root/numpy/ma
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2014-07-27 13:23:17 -0500
committerCharles Harris <charlesr.harris@gmail.com>2014-07-27 13:23:17 -0500
commit656cf247e531c1ebfb69e864e00620b10082b120 (patch)
treeda9b09ea7d81664f43f4f4160c502ed1c0c365d1 /numpy/ma
parent9ae5b5fab9f0c04c31c5d4b67d00c3cc79062731 (diff)
parent638e627c813590a91514b255aeb13a34dc2ac51e (diff)
downloadnumpy-656cf247e531c1ebfb69e864e00620b10082b120.tar.gz
Merge pull request #4905 from juliantaylor/doc-update
documentation updates
Diffstat (limited to 'numpy/ma')
-rw-r--r--numpy/ma/core.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/numpy/ma/core.py b/numpy/ma/core.py
index 5684bf8fd..00164b851 100644
--- a/numpy/ma/core.py
+++ b/numpy/ma/core.py
@@ -5021,6 +5021,10 @@ class MaskedArray(ndarray):
endwith : {True, False}, optional
Whether missing values (if any) should be forced in the upper indices
(at the end of the array) (True) or lower indices (at the beginning).
+ When the array contains unmasked values of the largest (or smallest if
+ False) representable value of the datatype the ordering of these values
+ and the masked values is undefined. To enforce the masked values are
+ at the end (beginning) in this case one must sort the mask.
fill_value : {var}, optional
Value used internally for the masked values.
If ``fill_value`` is not None, it supersedes ``endwith``.