updated documentation pydata#2304

Author: Daoud Jahdou

xarray/backends/api.py

@@ -230,8 +230,8 @@ def open_dataset(filename_or_obj, group=None, decode_cf=True,
         dataset. This may be useful to drop variables with problems or
         inconsistent values.
     force_promote_float64: bool
-        If True force int variables to be promoted to float64 instead of
-        float32
+        If True force int variables with scale factorto be promoted to
+        float64 instead of float32
     backend_kwargs: dictionary, optional
         A dictionary of keyword arguments to pass on to the backend. This
         may be useful when backend options would improve performance or
@@ -432,8 +432,8 @@ def open_dataarray(filename_or_obj, group=None, decode_cf=True,
         dataset. This may be useful to drop variables with problems or
         inconsistent values.
     force_promote_float64: bool
-        If True force int variables to be promoted to float64 instead of
-        float32
+        If True force int variables with scale factor to be promoted to
+        float64 instead of float32
     backend_kwargs: dictionary, optional
         A dictionary of keyword arguments to pass on to the backend. This
         may be useful when backend options would improve performance or

xarray/core/dtypes.py

@@ -30,8 +30,8 @@ def __eq__(self, other):
 INF = AlwaysGreaterThan()
 NINF = AlwaysLessThan()
 
-# Constant that indicates that we
-# must switch to float64 instead of
+# Constant that indicates if we
+# want to promote to float64 instead of
 # float32 even if dtype.itemsize <= 2
 FORCE_PROMOTE_FLOAT64 = False