Skip to content

Commit

Permalink
Documentation about trim_approx in swt2 is wrong (#567)
Browse files Browse the repository at this point in the history
The argument "trim_approx" was mixed up in the documentation of swt2. I just propose to switch True and False in the text.
  • Loading branch information
ElConno committed Sep 8, 2020
1 parent c36b9e9 commit c306fd6
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions pywt/_swt.py
Expand Up @@ -286,7 +286,7 @@ def swt2(data, wavelet, level, start_level=0, axes=(-2, -1),
-------
coeffs : list
Approximation and details coefficients (for ``start_level = m``).
If ``trim_approx`` is ``True``, approximation coefficients are
If ``trim_approx`` is ``False``, approximation coefficients are
retained for all levels::
[
Expand All @@ -305,7 +305,7 @@ def swt2(data, wavelet, level, start_level=0, axes=(-2, -1),
where cA is approximation, cH is horizontal details, cV is
vertical details, cD is diagonal details and m is ``start_level``.
If ``trim_approx`` is ``False``, approximation coefficients are only
If ``trim_approx`` is ``True``, approximation coefficients are only
retained at the final level of decomposition. This matches the format
used by ``pywt.wavedec2``::
Expand Down

0 comments on commit c306fd6

Please sign in to comment.