Skip to content

Commit 955401e

Browse files
committed
Fix some of the docstrings
1 parent 50f9906 commit 955401e

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

src/czt.jl

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Chirp z transform along a single direction d of an ND array `xin` into the ND ar
77
Note that xin and xout can be the same array for inplace operations.
88
Note that the result type is defined by `eltype(xin)` and not by `scales`.
99
10-
#References: Rabiner, Schafer, Rader, The Cirp z-Transform Algorithm, IEEE Trans AU 17(1969) p. 86
10+
# References: Rabiner, Schafer, Rader, The Cirp z-Transform Algorithm, IEEE Trans AU 17(1969) p. 86
1111
This code is loosely based on a 2D Matlab version of the CZT, written by N.G. Worku & H. Gross
1212
with their consent (28. Oct. 2020) to make it openly available.
1313
@@ -91,9 +91,9 @@ Chirp z transform of the ND array `xin`
9191
This code is based on a 2D Matlab version of the CZT, written by H. Gross.
9292
The tuple `scale` defines the zoom factors in the Fourier domain. Each has to be bigger than one.
9393
94-
#See also: iczt, czt_1d
94+
# See also: `iczt`, `czt_1d`
9595
96-
#References: Rabiner, Schafer, Rader, The Cirp z-Transform Algorithm, IEEE Trans AU 17(1969) p. 86
96+
# References: Rabiner, Schafer, Rader, The Cirp z-Transform Algorithm, IEEE Trans AU 17(1969) p. 86
9797
9898
# Arguments:
9999
+ `xin`: array to transform
@@ -103,8 +103,9 @@ The tuple `scale` defines the zoom factors in the Fourier domain. Each has to be
103103
+ `remove_wrap`: if true, the wrapped places will be set to zero.
104104
Note that the `pad_value` argument is only allowed for czt_1d to not cause confusion.
105105
106-
#Example:
107-
```jdoctest
106+
# Example:
107+
#
108+
```jldoctest
108109
julia> using IndexFunArrays
109110
110111
julia> sz = (10,10);
@@ -162,7 +163,7 @@ Inverse chirp z transform of the ND array `xin`
162163
This code is based on a 2D Matlab version of the CZT, written by H. Gross.
163164
The tuple `scale` defines the zoom factors in the Fourier domain. Each has to be bigger than one.
164165
165-
#References: Rabiner, Schafer, Rader, The Cirp z-Transform Algorithm, IEEE Trans AU 17(1969) p. 86
166+
# References: Rabiner, Schafer, Rader, The Cirp z-Transform Algorithm, IEEE Trans AU 17(1969) p. 86
166167
167168
# Arguments:
168169
+ `xin`: array to transform
@@ -172,10 +173,10 @@ The tuple `scale` defines the zoom factors in the Fourier domain. Each has to be
172173
+ `remove_wrap`: if true, the wrapped places will be set to zero.
173174
Note that the `pad_value` argument is only allowed for 1d czts to not cause confusion.
174175
175-
#See also: czt, czt_1d
176+
# See also: czt, czt_1d
176177
177-
#Example:
178-
```jdoctest
178+
# Example:
179+
```jldoctest
179180
julia> using IndexFunArrays
180181
181182
julia> sz = (10,10);

0 commit comments

Comments
 (0)