Fixes pydata#5898

andersy005 · Nov 8, 2021 · 99bfe12 · 99bfe12
1 parent 7f39cc0
commit 99bfe12
Show file tree

Hide file tree

Showing 2 changed files with 153 additions and 0 deletions.
diff --git a/xarray/core/_reductions.py b/xarray/core/_reductions.py
@@ -496,6 +496,10 @@ def mean(
         Data variables:
             da       float64 nan
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.mean
@@ -597,6 +601,10 @@ def prod(
         Data variables:
             da       float64 12.0
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.prod
@@ -699,6 +707,10 @@ def sum(
         Data variables:
             da       float64 9.0
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.sum
@@ -798,6 +810,10 @@ def std(
         Data variables:
             da       float64 0.8367
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.std
@@ -897,6 +913,10 @@ def var(
         Data variables:
             da       float64 0.7
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.var
@@ -984,6 +1004,10 @@ def median(
         Data variables:
             da       float64 nan
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.median
@@ -1418,6 +1442,10 @@ def mean(
         <xarray.DataArray ()>
         array(nan)
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.mean
@@ -1509,6 +1537,10 @@ def prod(
         <xarray.DataArray ()>
         array(12.)
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.prod
@@ -1601,6 +1633,10 @@ def sum(
         <xarray.DataArray ()>
         array(9.)
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.sum
@@ -1690,6 +1726,10 @@ def std(
         <xarray.DataArray ()>
         array(0.83666003)
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.std
@@ -1779,6 +1819,10 @@ def var(
         <xarray.DataArray ()>
         array(0.7)
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.var
@@ -1858,6 +1902,10 @@ def median(
         <xarray.DataArray ()>
         array(nan)
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.median
@@ -2350,6 +2398,10 @@ def mean(
         Data variables:
             da       (labels) float64 nan 2.0 2.0
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.mean
@@ -2457,6 +2509,10 @@ def prod(
         Data variables:
             da       (labels) float64 nan 4.0 3.0
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.prod
@@ -2565,6 +2621,10 @@ def sum(
         Data variables:
             da       (labels) float64 nan 4.0 4.0
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.sum
@@ -2670,6 +2730,10 @@ def std(
         Data variables:
             da       (labels) float64 nan 0.0 1.414
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.std
@@ -2775,6 +2839,10 @@ def var(
         Data variables:
             da       (labels) float64 nan 0.0 2.0
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.var
@@ -2866,6 +2934,10 @@ def median(
         Data variables:
             da       (labels) float64 nan 2.0 2.0
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.median
@@ -3359,6 +3431,10 @@ def mean(
         Data variables:
             da       (time) float64 1.0 2.0 nan
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.mean
@@ -3466,6 +3542,10 @@ def prod(
         Data variables:
             da       (time) float64 nan 6.0 nan
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.prod
@@ -3574,6 +3654,10 @@ def sum(
         Data variables:
             da       (time) float64 nan 6.0 nan
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.sum
@@ -3679,6 +3763,10 @@ def std(
         Data variables:
             da       (time) float64 nan 1.0 nan
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.std
@@ -3784,6 +3872,10 @@ def var(
         Data variables:
             da       (time) float64 nan 1.0 nan
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.var
@@ -3875,6 +3967,10 @@ def median(
         Data variables:
             da       (time) float64 1.0 2.0 nan
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.median
@@ -4327,6 +4423,10 @@ def mean(
         Coordinates:
           * labels   (labels) object 'a' 'b' 'c'
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.mean
@@ -4424,6 +4524,10 @@ def prod(
         Coordinates:
           * labels   (labels) object 'a' 'b' 'c'
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.prod
@@ -4522,6 +4626,10 @@ def sum(
         Coordinates:
           * labels   (labels) object 'a' 'b' 'c'
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.sum
@@ -4617,6 +4725,10 @@ def std(
         Coordinates:
           * labels   (labels) object 'a' 'b' 'c'
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.std
@@ -4712,6 +4824,10 @@ def var(
         Coordinates:
           * labels   (labels) object 'a' 'b' 'c'
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.var
@@ -4795,6 +4911,10 @@ def median(
         Coordinates:
           * labels   (labels) object 'a' 'b' 'c'
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.median
@@ -5246,6 +5366,10 @@ def mean(
         Coordinates:
           * time     (time) datetime64[ns] 2001-01-31 2001-04-30 2001-07-31
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.mean
@@ -5343,6 +5467,10 @@ def prod(
         Coordinates:
           * time     (time) datetime64[ns] 2001-01-31 2001-04-30 2001-07-31
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.prod
@@ -5441,6 +5569,10 @@ def sum(
         Coordinates:
           * time     (time) datetime64[ns] 2001-01-31 2001-04-30 2001-07-31
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.sum
@@ -5536,6 +5668,10 @@ def std(
         Coordinates:
           * time     (time) datetime64[ns] 2001-01-31 2001-04-30 2001-07-31
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.std
@@ -5631,6 +5767,10 @@ def var(
         Coordinates:
           * time     (time) datetime64[ns] 2001-01-31 2001-04-30 2001-07-31
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.var
@@ -5714,6 +5854,10 @@ def median(
         Coordinates:
           * time     (time) datetime64[ns] 2001-01-31 2001-04-30 2001-07-31
 
+        Notes
+        -----
+        Non-numeric variables will be removed prior to reducing.
+
         See Also
         --------
         numpy.median