Skip to content

Commit 154a013

Browse files
devmotionoschulz
authored andcommitted
Update documentation
1 parent a40c765 commit 154a013

File tree

2 files changed

+7
-28
lines changed

2 files changed

+7
-28
lines changed

docs/src/api.md

Lines changed: 3 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,7 @@
11
# API
22

3-
```@meta
4-
DocTestSetup = quote
5-
using ChangesOfVariables
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
22-
23-
```@index
24-
Order = [:macro, :function]
25-
```
26-
27-
# Documentation
3+
## Interface
284

29-
```@autodocs
30-
Modules = [ChangesOfVariables]
31-
Order = [:module, :type, :constant, :macro, :function]
5+
```@docs
6+
with_logabsdet_jacobian
327
```

docs/src/index.md

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

3+
```@docs
4+
ChangesOfVariables
5+
```
6+
37
This package defines the function [`with_logabsdet_jacobian`](@ref). `(y, ladj) = with_logabsdet_jacobian(f, x)` computes both the transformed value of `x` under the transformation `f` and the logarithm of the [volume element](https://en.wikipedia.org/wiki/Volume_element).
48

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

0 commit comments

Comments
 (0)