Edit docstrings

Format keyword arguments more consistently and correct spelling.

xrft/padding.py

@@ -297,7 +297,7 @@ def _pad_coordinates_callback(vector, iaxis_pad_width, iaxis, kwargs):
         the function will check if it's equal to zero. It exists for
         compatibility with the ``padding_func`` callback that :func:`numpy.pad`
         needs.
-    kwargs : dict
+    **kwargs
         Any keyword arguments the function requires. The kwargs are ignored in
         this function, they exist for compatibility with the ``padding_func``
         callback that :func:`numpy.pad` needs.
@@ -338,13 +338,13 @@ def unpad(da, pad_width=None, **pad_width_kwargs):
         {dim: pad} is a shortcut for pad_before = pad_after = pad.
         If ``None``, then the *pad_width* for each coordinate is read from
         their ``pad_width`` attribute.
-    **pad_width_kwargs (optional)
+    **pad_width_kwargs
         The keyword arguments form of ``pad_width``.
         Pass ``pad_width`` or ``pad_width_kwargs``.
 
     Returns
     -------
-    da_unpaded : :class:`xarray.DataArray`
+    da_unpadded : :class:`xarray.DataArray`
         Unpadded array.
 
     See also

xrft/xrft.py

@@ -712,7 +712,8 @@ def power_spectrum(
         If scaling = 'density', correct for the energy (integral) of the spectrum. This ensures, for example, that the power spectral density integrates to the square of the RMS of the signal (ie that Parseval's theorem is satisfied). Note that in most cases, Parseval's theorem will only be approximately satisfied with this correction as it assumes that the signal being windowed is independent of the window. The correction becomes more accurate as the width of the window gets large in comparison with any noticeable period in the signal.
         If False, the spectrum gives a representation of the power in the windowed signal.
         Note that when True, Parseval's theorem may only be approximately satisfied.
-    kwargs : dict : see xrft.fft for argument list
+    **kwargs
+        See `xrft.fft` for valid arguments.
     """
 
     if "density" in kwargs:
@@ -793,7 +794,8 @@ def cross_spectrum(
         If True, the phase information is retained.
         Set explicitly true_phase = False in cross_spectrum arguments list to ensure future compatibility
         with numpy-like behavior where the coordinates are disregarded.
-    kwargs : dict : see xrft.fft for argument list
+    **kwargs
+        See `xrft.fft` for valid arguments.
     """
 
     if "real" in kwargs:
@@ -859,7 +861,8 @@ def cross_phase(da1, da2, dim=None, true_phase=True, **kwargs):
         If True, the phase information is retained.
         Set explicitly true_phase = False in cross_spectrum arguments list to ensure future compatibility
         with numpy-like behavior where the coordinates are disregarded.
-    kwargs : dict : see xrft.fft for argument list
+    **kwargs
+        See `xrft.fft` for valid arguments.
     """
 
     cp = xr.apply_ufunc(