BUG: Functions in ma should not add Notes to existing docstrings.

Currently, the `doc_note` function in `numpy.ma.core.py` is called to
add a "Notes" section to the existing docstrings of the unmasked
versions of some functions. This may result in duplicate "Notes"
sections, or incorrect placement, which are errors in current numpydoc.
This PR disables the `doc_note` function until we can decide on the
proper way to deal with the problem.

1 files changed, 7 insertions, 5 deletions

diff --git a/numpy/ma/core.py b/numpy/ma/core.py
index 4008a1ece..57a4827ff 100644
--- a/numpy/ma/core.py
+++ b/numpy/ma/core.py
@@ -131,6 +131,12 @@ def doc_note(initialdoc, note):
         return
     if note is None:
         return initialdoc
+
+    # FIXME: disable this function for the moment until we figure out what to
+    # do with it. Currently it may result in duplicate Notes sections or Notes
+    # sections in the wrong place
+    return initialdoc
+
     newdoc = """
     %s
 
@@ -7481,11 +7487,7 @@ def inner(a, b):
     Returns the inner product of a and b for arrays of floating point types.
 
     Like the generic NumPy equivalent the product sum is over the last dimension
-    of a and b.
-
-    Notes
-    -----
-    The first argument is not conjugated.
+    of a and b. The first argument is not conjugated.
 
     """
     fa = filled(a, 0)