Skip to content

Commit f9040da

Browse files
authored
reorganize library docstrings (#792)
1 parent 6a5fbf9 commit f9040da

File tree

3 files changed

+35
-38
lines changed

3 files changed

+35
-38
lines changed

docs/src/library.md

Lines changed: 19 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,5 @@
11
# Library
22

3-
4-
## Constructing a Fun
5-
6-
```@docs
7-
Fun
8-
```
9-
10-
```@docs
11-
ones(::Space)
12-
```
13-
14-
```@docs
15-
zeros(::Space)
16-
```
17-
18-
193
## Domains
204
```@docs
215
Arc
@@ -146,9 +130,6 @@ CosSpace
146130
SinSpace
147131
```
148132

149-
150-
151-
152133
```@docs
153134
JacobiWeight
154135
```
@@ -165,6 +146,19 @@ ApproxFun.ArraySpace
165146
TensorSpace
166147
```
167148

149+
## Constructing a Fun
150+
151+
```@docs
152+
Fun
153+
```
154+
155+
```@docs
156+
ones(::Space)
157+
```
158+
159+
```@docs
160+
zeros(::Space)
161+
```
168162

169163
## Accessing information about a Fun
170164

@@ -188,7 +182,6 @@ ncoefficients
188182
points
189183
```
190184

191-
192185
```@docs
193186
space
194187
```
@@ -212,11 +205,16 @@ reverseorientation
212205
ApproxFun.setdomain
213206
```
214207

215-
216208
```@docs
217209
chop(::Fun, ::Any)
218210
```
219211

212+
## Bivariate Fun
213+
214+
```@docs
215+
LowRankFun
216+
```
217+
220218

221219
## Operators
222220

@@ -292,9 +290,3 @@ Multiplication
292290
```@docs
293291
Neumann
294292
```
295-
296-
## Bivariate
297-
298-
```@docs
299-
LowRankFun
300-
```

docs/travis.sh

Lines changed: 0 additions & 6 deletions
This file was deleted.

src/docs.jl

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
2-
3-
4-
51
## Fun.jl docs
62

73
# Constructors
@@ -409,7 +405,22 @@ Defaults to `coefficients(transform(canonicalspace(space),values),canonicalspace
409405
410406
# Examples
411407
```jldoctest
412-
julia> v = map(x -> x^2, points(Chebyshev(), 4));
408+
julia> f = x -> x^2;
409+
410+
julia> F = Fun(f, Chebyshev());
411+
412+
julia> coefficients(F)
413+
3-element Vector{Float64}:
414+
0.5
415+
0.0
416+
0.5
417+
418+
julia> v = map(f, points(Chebyshev(), 3));
419+
420+
julia> transform(Chebyshev(), v) ≈ coefficients(F)
421+
true
422+
423+
julia> v = map(f, points(Chebyshev(), 4));
413424
414425
julia> transform(Chebyshev(), v)
415426
4-element Vector{Float64}:

0 commit comments

Comments
 (0)