fix #335 : Standardize nan to NaN in all docstrings. Keep nan when printing values. (same as Numpy).

Author: alixdamman

larray/core/array.py

@@ -1113,7 +1113,7 @@ def to_series(self, name=None, dropna=False):
             b2    5.0
         Name: my_name, dtype: float64
 
-        Drop nan values
+        Drop NaN values
 
         >>> arr['b1'] = nan
         >>> arr
@@ -5139,9 +5139,9 @@ def equals(self, other, rtol=0, atol=0, nans_equal=False, check_axes=False):
         atol : float or int, optional
             The absolute tolerance parameter (see Notes). Defaults to 0.
         nans_equal : boolean, optional
-            Whether or not to consider nan values at the same positions in the two arrays as equal.
-            By default, an array containing nan values is never equal to another array, even if that other array
-            also contains nan values at the same positions. The reason is that a nan value is different from
+            Whether or not to consider NaN values at the same positions in the two arrays as equal.
+            By default, an array containing NaN values is never equal to another array, even if that other array
+            also contains NaN values at the same positions. The reason is that a NaN value is different from
             *anything*, including itself. Defaults to False.
         check_axes : boolean, optional
             Whether or not to check that the set of axes and their order is the same on both sides. Defaults to False.
@@ -5201,7 +5201,7 @@ def equals(self, other, rtol=0, atol=0, nans_equal=False, check_axes=False):
         >>> arr2.equals(arr1, rtol=0.01)
         True
 
-        Arrays with nan values
+        Arrays with NaN values
 
         >>> arr1 = ndtest((2, 3), dtype=float)
         >>> arr1['a1', 'b1'] = nan
@@ -5210,9 +5210,9 @@ def equals(self, other, rtol=0, atol=0, nans_equal=False, check_axes=False):
          a0  0.0  1.0  2.0
          a1  3.0  nan  5.0
         >>> arr2 = arr1.copy()
-        >>> # By default, an array containing nan values is never equal to another array,
-        >>> # even if that other array also contains nan values at the same positions.
-        >>> # The reason is that a nan value is different from *anything*, including itself.
+        >>> # By default, an array containing NaN values is never equal to another array,
+        >>> # even if that other array also contains NaN values at the same positions.
+        >>> # The reason is that a NaN value is different from *anything*, including itself.
         >>> arr2.equals(arr1)
         False
         >>> # set flag nans_equal to True to overwrite this behavior
@@ -5271,16 +5271,16 @@ def eq(self, other, rtol=0, atol=0, nans_equal=False):
         atol : float or int, optional
             The absolute tolerance parameter (see Notes). Defaults to 0.
         nans_equal : boolean, optional
-            Whether or not to consider nan values at the same positions in the two arrays as equal.
-            By default, an array containing nan values is never equal to another array, even if that other array
-            also contains nan values at the same positions. The reason is that a nan value is different from
+            Whether or not to consider Nan values at the same positions in the two arrays as equal.
+            By default, an array containing NaN values is never equal to another array, even if that other array
+            also contains NaN values at the same positions. The reason is that a NaN value is different from
             *anything*, including itself. Defaults to False.
 
         Returns
         -------
         LArray
             Boolean array where each cell tells whether corresponding elements of self and other are equal
-            within a tolerance range if given. If nans_equal=True, corresponding elements with nan values
+            within a tolerance range if given. If nans_equal=True, corresponding elements with NaN values
             will be considered as equal.
 
         See Also

larray/core/ufuncs.py

@@ -150,7 +150,7 @@ def wrapper(*args, **kwargs):
     Notes
     -----
     The maximum is equivalent to ``where(x1 >= x2, x1, x2)`` when
-    neither x1 nor x2 are nans, but it is faster.
+    neither x1 nor x2 are NaNs, but it is faster.
 
     Examples
     --------