docs: reverting some docstring array shape info

Author: PinkShnack

README.rst

@@ -94,14 +94,14 @@ For type hinting and docstring styling, try to keep the
 Code Reference readable in the documentation website.
 If in doubt just ask, or look at the examples in the codebase.
 
-* Simple type combintions such as `float` or `str | pathlib.Path`
+* Simple type combintions such as ``float`` or ``str | pathlib.Path``
   should be included as type hints, but do not need to be included
   in the docstring parameter description.
 * More involved type hints can have extra information in the 
-  docstring. For example for numpy arrays, `npt.NDArray[np.bool]` doesn't
+  docstring. For example for numpy arrays, ``npt.NDArray[np.bool]`` doesn't
   render in a readable way in the Code Reference, and doesn't include shape.
   Therefore, you can also keep the docstring parameter description e.g.,
-  `binary ndarray of shape (M, N)`.
+  ``binary ndarray of shape (M, N)``.
 
 
 Incrementing version

dclab/features/emodulus/scale_linear.py

@@ -21,7 +21,7 @@ def convert(area_um: npt.NDArray,
         tuple[npt.NDArray, npt.NDArray] |
         tuple[npt.NDArray, npt.NDArray, npt.NDArray]
 ):
-    """convert area-deformation-emodulus triplet
+    """Convert area-deformation-emodulus triplet
 
     The conversion formula is described in :cite:`Mietke2015`.
 

dclab/features/emodulus/viscosity.py

@@ -258,7 +258,7 @@ def get_viscosity_mc_pbs_herold_2017(
 
 
 def get_viscosity_water_kestin_1978(
-        temperature: float = 23.0) -> float | npt.NDArray:
+        temperature: float | npt.NDArray = 23.0) -> float | npt.NDArray:
     """Compute the viscosity of water according to :cite:`Kestin_1978`"""
     # see equation (15) in Kestin et al, J. Phys. Chem. 7(3) 1978
     check_temperature("'kestin-1978' water", temperature, 0, 40)

dclab/features/inert_ratio.py

@@ -16,7 +16,7 @@ def cont_moments_cv(cont: npt.NDArray,
 
     Parameters
     ----------
-    cont: shape (N,2)
+    cont: ndarray of shape (N,2)
         The contour for which to compute the moments.
     flt_epsilon
         The value of ``FLT_EPSILON`` in OpenCV/gcc.

dclab/features/volume.py

@@ -138,7 +138,7 @@ def counter_clockwise(cx: npt.NDArray, cy: npt.NDArray) -> tuple[float, float]:
 
     Parameters
     ----------
-    cx, cy
+    cx, cy: 1d ndarrays
         The x- and y-coordinates of the contour
 
     Returns
@@ -193,9 +193,9 @@ def vol_revolve(r: npt.NDArray,
 
     Parameters
     ----------
-    r
+    r: 1d ndarray
         radial coordinates (perpendicular to the z axis)
-    z
+    z: 1d ndarray
         coordinate along the axis of rotation
     point_scale
         point size in your preferred units; The volume is multiplied