Skip to content

Commit a0057f8

Browse files
authored
update docstrings (#43)
1 parent 584cad0 commit a0057f8

File tree

1 file changed

+40
-6
lines changed

1 file changed

+40
-6
lines changed

src/ApproxFunFourier.jl

Lines changed: 40 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -100,12 +100,26 @@ for T in (:CosSpace,:SinSpace)
100100
end
101101

102102
"""
103-
`CosSpace()` is the space spanned by `[1,cos θ,cos 2θ,...]`
103+
CosSpace()
104+
The space spanned by `[1, cos θ, cos 2θ, ...]`
105+
106+
---
107+
108+
CosSpace(d::Domain)
109+
110+
The space spanned by `[1,cos(2pi/L*θ), cos(2pi/L*2θ), ...]` for a domain with a period `L`
104111
"""
105112
CosSpace()
106113

107114
"""
108-
`SinSpace()` is the space spanned by `[sin θ,sin 2θ,...]`
115+
SinSpace()
116+
The space spanned by `[sin θ, sin 2θ, ...]`
117+
118+
---
119+
120+
SinSpace(d::Domain)
121+
122+
The space spanned by `[1, sin(2pi/L*θ), sin(2pi/L*2θ), ...]` for a domain with a period `L`
109123
"""
110124
SinSpace()
111125

@@ -301,11 +315,21 @@ evaluate(f::AbstractVector,S::SinSpace,t) = sineshaw(f,tocanonical(S,t))
301315

302316
## Laurent space
303317
"""
304-
`Laurent()` is the space spanned by the complex exponentials
318+
Laurent()
319+
The space spanned by the complex exponentials
305320
```
306321
1,exp(-im*θ),exp(im*θ),exp(-2im*θ),…
307322
```
308-
See also `Fourier`.
323+
See also [`Fourier`](@ref).
324+
325+
---
326+
327+
Laurent(d::Domain)
328+
The space spanned by the complex exponentials
329+
```
330+
1, exp(-im * (2pi/L*θ)), exp(im * (2pi/L*θ)), exp(-2im * (2pi/L*θ)), …
331+
```
332+
for a domain with a period `L`.
309333
"""
310334
const Laurent{DD,RR} = SumSpace{Tuple{Hardy{true,DD,RR},Hardy{false,DD,RR}},DD,RR}
311335

@@ -393,11 +417,21 @@ end
393417
## Fourier space
394418

395419
"""
396-
`Fourier()` is the space spanned by the trigonemtric polynomials
420+
Fourier()
421+
The space spanned by the trigonemtric polynomials
397422
```
398-
1,sin(θ),cos(θ),sin(2θ),cos(2θ),…
423+
1, sin(θ), cos(θ), sin(2θ), cos(2θ),
399424
```
400425
See also `Laurent`.
426+
427+
---
428+
429+
Fourier(d::Domain)
430+
The space spanned by the trigonemtric polynomials
431+
```
432+
1, sin(2pi/L*θ), cos(2pi/L*θ), sin(2pi/L*2θ), cos(2pi/L*2θ), …
433+
```
434+
for a domain with a period `L`.
401435
"""
402436
const Fourier{DD,RR} = SumSpace{Tuple{CosSpace{DD,RR},SinSpace{DD,RR}},DD,RR}
403437

0 commit comments

Comments
 (0)