Skip to content

Commit c914bf7

Browse files
devmotionoschulz
authored andcommitted
Update documentation
1 parent 532fa13 commit c914bf7

File tree

2 files changed

+10
-25
lines changed

2 files changed

+10
-25
lines changed

docs/src/api.md

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,13 @@
11
# API
22

3-
```@meta
4-
DocTestSetup = quote
5-
using InverseFunctions
6-
end
7-
```
8-
9-
## Modules
10-
11-
```@index
12-
Order = [:module]
13-
```
14-
15-
## Types and constants
16-
17-
```@index
18-
Order = [:type, :constant]
19-
```
20-
21-
## Functions and macros
3+
## Interface
224

23-
```@index
24-
Order = [:macro, :function]
5+
```@docs
6+
inverse
257
```
268

27-
# Documentation
9+
## Test utility
2810

29-
```@autodocs
30-
Modules = [InverseFunctions]
31-
Order = [:module, :type, :constant, :macro, :function]
11+
```@docs
12+
InverseFunctions.test_inverse
3213
```

docs/src/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# InverseFunctions.jl
22

3+
```@docs
4+
InverseFunctions
5+
```
6+
37
This package defines the function [`inverse`](@ref). `inverse(f)` returns the inverse function of a function `f`, so that `inverse(f)(f(x)) ≈ x`.
48

59
`inverse` supports mapped/broadcasted functions (via `Base.Fix1`) and (on Julia >=v1.6) function composition.

0 commit comments

Comments
 (0)