DOC: consistently link Modes documentation from docstrings

Author: grlee77

pywt/_dwt.py

@@ -93,7 +93,7 @@ def dwt_coeff_len(data_len, filter_len, mode):
     filter_len : int
         Filter length.
     mode : str, optional (default: 'symmetric')
-        Signal extension mode, see Modes
+        Signal extension mode, see :ref:`Modes <ref-modes>`.
 
     Returns
     -------
@@ -130,12 +130,11 @@ def dwt(data, wavelet, mode='symmetric', axis=-1):
     wavelet : Wavelet object or name
         Wavelet to use
     mode : str, optional
-        Signal extension mode, see Modes
+        Signal extension mode, see :ref:`Modes <ref-modes>`.
     axis: int, optional
         Axis over which to compute the DWT. If not given, the
         last axis is used.
 
-
     Returns
     -------
     (cA, cD) : tuple
@@ -206,12 +205,11 @@ def idwt(cA, cD, wavelet, mode='symmetric', axis=-1):
     wavelet : Wavelet object or name
         Wavelet to use
     mode : str, optional (default: 'symmetric')
-        Signal extension mode, see Modes
+        Signal extension mode, see :ref:`Modes <ref-modes>`.
     axis: int, optional
         Axis over which to compute the inverse DWT. If not given, the
         last axis is used.
 
-
     Returns
     -------
     rec: array_like
@@ -316,7 +314,7 @@ def downcoef(part, data, wavelet, mode='symmetric', level=1):
     wavelet : Wavelet object or name
         Wavelet to use
     mode : str, optional
-        Signal extension mode, see `Modes`.  Default is 'symmetric'.
+        Signal extension mode, see :ref:`Modes <ref-modes>`.
     level : int, optional
         Decomposition level.  Default is 1.
 
@@ -406,7 +404,7 @@ def upcoef(part, coeffs, wavelet, level=1, take=0):
 def pad(x, pad_widths, mode):
     """Extend a 1D signal using a given boundary mode.
 
-    This function operates like `numpy.pad` but supports all signal extension
+    This function operates like ``numpy.pad`` but supports all signal extension
     modes that can be used by PyWavelets discrete wavelet transforms.
 
     Parameters
@@ -420,7 +418,7 @@ def pad(x, pad_widths, mode):
         axis. (pad,) or int is a shortcut for before = after = pad width for
         all axes.
     mode : str, optional
-        Signal extension mode, see Modes.
+        Signal extension mode, see :ref:`Modes <ref-modes>`.
 
     Returns
     -------
@@ -430,9 +428,9 @@ def pad(x, pad_widths, mode):
 
     Notes
     -----
-    The performance of padding in dimensions > 1 will be substantially slower
-    for modes `smooth` and `antisymmetric` as these modes are not supported in
-    an efficient manner by the underlying `numpy.pad` function.
+    The performance of padding in dimensions > 1 may be substantially slower
+    for modes ``smooth`` and ``antisymmetric`` as these modes are not supported
+    efficiently by the underlying ``numpy.pad`` function.
     """
     x = np.asanyarray(x)
 

pywt/_multidim.py

@@ -33,8 +33,8 @@ def dwt2(data, wavelet, mode='symmetric', axes=(-2, -1)):
         Wavelet to use.  This can also be a tuple containing a wavelet to
         apply along each axis in ``axes``.
     mode : str or 2-tuple of strings, optional
-        Signal extension mode, see Modes (default: 'symmetric').  This can
-        also be a tuple of modes specifying the mode to use on each axis in
+        Signal extension mode, see :ref:`Modes <ref-modes>`. This can also
+        be a tuple of modes specifying the mode to use on each axis in
         ``axes``.
     axes : 2-tuple of ints, optional
         Axes over which to compute the DWT. Repeated elements mean the DWT will
@@ -90,9 +90,8 @@ def idwt2(coeffs, wavelet, mode='symmetric', axes=(-2, -1)):
         Wavelet to use.  This can also be a tuple containing a wavelet to
         apply along each axis in ``axes``.
     mode : str or 2-tuple of strings, optional
-        Signal extension mode, see Modes (default: 'symmetric').  This can
-        also be a tuple of modes specifying the mode to use on each axis in
-        ``axes``.
+        Signal extension mode, see :ref:`Modes <ref-modes>`. This can also be
+        a tuple of modes specifying the mode to use on each axis in ``axes``.
     axes : 2-tuple of ints, optional
         Axes over which to compute the IDWT. Repeated elements mean the IDWT
         will be performed multiple times along these axes.
@@ -131,7 +130,7 @@ def dwtn(data, wavelet, mode='symmetric', axes=None):
         apply along each axis in ``axes``.
     mode : str or tuple of string, optional
         Signal extension mode used in the decomposition,
-        see Modes (default: 'symmetric').  This can also be a tuple of modes
+        see :ref:`Modes <ref-modes>`. This can also be a tuple of modes
         specifying the mode to use on each axis in ``axes``.
     axes : sequence of ints, optional
         Axes over which to compute the DWT. Repeated elements mean the DWT will
@@ -233,7 +232,7 @@ def idwtn(coeffs, wavelet, mode='symmetric', axes=None):
         apply along each axis in ``axes``.
     mode : str or list of string, optional
         Signal extension mode used in the decomposition,
-        see Modes (default: 'symmetric').  This can also be a tuple of modes
+        see :ref:`Modes <ref-modes>`. This can also be a tuple of modes
         specifying the mode to use on each axis in ``axes``.
     axes : sequence of ints, optional
         Axes over which to compute the IDWT. Repeated elements mean the IDWT

pywt/_multilevel.py

@@ -57,7 +57,7 @@ def wavedec(data, wavelet, mode='symmetric', level=None, axis=-1):
     wavelet : Wavelet object or name string
         Wavelet to use
     mode : str, optional
-        Signal extension mode, see `Modes` (default: 'symmetric')
+        Signal extension mode, see :ref:`Modes <ref-modes>`.
     level : int, optional
         Decomposition level (must be >= 0). If level is None (default) then it
         will be calculated using the `dwt_max_level` function.
@@ -119,7 +119,7 @@ def waverec(coeffs, wavelet, mode='symmetric', axis=-1):
     wavelet : Wavelet object or name string
         Wavelet to use
     mode : str, optional
-        Signal extension mode, see `Modes` (default: 'symmetric')
+        Signal extension mode, see :ref:`Modes <ref-modes>`.
     axis: int, optional
         Axis over which to compute the inverse DWT. If not given, the
         last axis is used.
@@ -185,7 +185,7 @@ def wavedec2(data, wavelet, mode='symmetric', level=None, axes=(-2, -1)):
         Wavelet to use.  This can also be a tuple containing a wavelet to
         apply along each axis in `axes`.
     mode : str or 2-tuple of str, optional
-        Signal extension mode, see `Modes` (default: 'symmetric').  This can
+        Signal extension mode, see :ref:`Modes <ref-modes>`. This can
         also be a tuple containing a mode to apply along each axis in `axes`.
     level : int, optional
         Decomposition level (must be >= 0). If level is None (default) then it
@@ -259,7 +259,7 @@ def waverec2(coeffs, wavelet, mode='symmetric', axes=(-2, -1)):
         Wavelet to use.  This can also be a tuple containing a wavelet to
         apply along each axis in `axes`.
     mode : str or 2-tuple of str, optional
-        Signal extension mode, see `Modes` (default: 'symmetric').  This can
+        Signal extension mode, see :ref:`Modes <ref-modes>`.  This can
         also be a tuple containing a mode to apply along each axis in `axes`.
     axes : 2-tuple of ints, optional
         Axes over which to compute the IDWT. Repeated elements are not allowed.
@@ -359,7 +359,7 @@ def wavedecn(data, wavelet, mode='symmetric', level=None, axes=None):
         Wavelet to use.  This can also be a tuple containing a wavelet to
         apply along each axis in `axes`.
     mode : str or tuple of str, optional
-        Signal extension mode, see `Modes` (default: 'symmetric').  This can
+        Signal extension mode, see :ref:`Modes <ref-modes>`. This can
         also be a tuple containing a mode to apply along each axis in `axes`.
     level : int, optional
         Decomposition level (must be >= 0). If level is None (default) then it
@@ -458,7 +458,7 @@ def waverecn(coeffs, wavelet, mode='symmetric', axes=None):
         Wavelet to use.  This can also be a tuple containing a wavelet to
         apply along each axis in `axes`.
     mode : str or tuple of str, optional
-        Signal extension mode, see `Modes` (default: 'symmetric').  This can
+        Signal extension mode, see :ref:`Modes <ref-modes>`. This can
         also be a tuple containing a mode to apply along each axis in `axes`.
     axes : sequence of ints, optional
         Axes over which to compute the IDWT.  Axes may not be repeated.
@@ -869,7 +869,7 @@ def wavedecn_shapes(shape, wavelet, mode='symmetric', level=None, axes=None):
         Wavelet to use.  This can also be a tuple containing a wavelet to
         apply along each axis in `axes`.
     mode : str or tuple of str, optional
-        Signal extension mode, see Modes (default: 'symmetric').  This can
+        Signal extension mode, see :ref:`Modes <ref-modes>`. This can
         also be a tuple containing a mode to apply along each axis in `axes`.
     level : int, optional
         Decomposition level (must be >= 0). If level is None (default) then it
@@ -1362,7 +1362,7 @@ def fswavedecn(data, wavelet, mode='symmetric', levels=None, axes=None):
         Wavelet to use.  This can also be a tuple containing a wavelet to
         apply along each axis in ``axes``.
     mode : str or tuple of str, optional
-        Signal extension mode, see `Modes` (default: 'symmetric').  This can
+        Signal extension mode, see :ref:`Modes <ref-modes>`.  This can
         also be a tuple containing a mode to apply along each axis in ``axes``.
     levels : int or sequence of ints, optional
         Decomposition levels along each axis (must be >= 0). If an integer is