Skip to content

Commit

Permalink
DOC: Clean up unneeded type conversions
Browse files Browse the repository at this point in the history
  • Loading branch information
agriyakhetarpal committed Jun 4, 2024
1 parent 5a331b2 commit 21e0158
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 24 deletions.
9 changes: 2 additions & 7 deletions doc/source/regression/dwt-idwt.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,17 +101,12 @@ data length but also on the :class:Wavelet type (particularly on its
To find out what the size of the output data will be, use the {func}`dwt_coeff_len`
function:

<!-- # int() is for normalizing Python integers and long integers
# for documentation tests -->
<!-- though the doctests might not be needed anymore because MyST is testing -->
<!-- these by executing the notebooks? -->

```{code-cell}
int(pywt.dwt_coeff_len(data_len=len(x), filter_len=w.dec_len, mode='symmetric'))
pywt.dwt_coeff_len(data_len=len(x), filter_len=w.dec_len, mode='symmetric')
```

```{code-cell}
int(pywt.dwt_coeff_len(len(x), w, 'symmetric'))
pywt.dwt_coeff_len(len(x), w, 'symmetric')
```

and the length of the output is:
Expand Down
7 changes: 2 additions & 5 deletions doc/source/regression/wavelet.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,15 +120,12 @@ print(w.family_name)

2. Decomposition ({attr}`~Wavelet.dec_len`) and reconstruction ({attr}`~.Wavelet.rec_len`) filter lengths:

<!-- # int() is for normalizing longs and ints for doctest -->
<!-- TODO: FIXME: note: might not be needed anymore -->

```{code-cell}
int(w.dec_len)
w.dec_len
```

```{code-cell}
int(w.rec_len)
w.rec_len
```

3. Orthogonality ({attr}`~Wavelet.orthogonal`) and biorthogonality ({attr}`~Wavelet.biorthogonal`):
Expand Down
9 changes: 0 additions & 9 deletions doc/source/regression/wp.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,6 @@ kernelspec:

+++

<!-- not sure if this is needed anymore? -->

```{code-cell}
---
tags: [hide-input]
---
from __future__ import print_function
```

# Wavelet Packets

## `import pywt` and construct a helper function
Expand Down
3 changes: 0 additions & 3 deletions doc/source/regression/wp2d.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,7 @@ kernelspec:

## Import pywt

<!-- TODO: check if needed anymore -->

```{code-cell}
from __future__ import print_function
import pywt
import numpy
```
Expand Down

0 comments on commit 21e0158

Please sign in to comment.