Add conversion docstring.

ACCESS-NRI · Sep 6, 2024 · 05238cd · 05238cd
1 parent 0cf8fd4
commit 05238cd
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/umpost/um2netcdf.py b/umpost/um2netcdf.py
@@ -738,6 +738,13 @@ def fix_level_coord(cube, z_rho, z_theta, tol=1e-6):
 
 
 def convert_32_bit(cube):
+    """
+    Convert 64 bit int/float data to 32 bit (in place).
+
+    Parameters
+    ----------
+    cube : iris.cube object to modify.
+    """
     if cube.data.dtype == 'float64':
         cube.data = cube.data.astype(np.float32)
     elif cube.data.dtype == 'int64':