Skip to content

Commit 8f6d1d3

Browse files
authored
Update index.md
1 parent f89a548 commit 8f6d1d3

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

docs/src/index.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,21 @@ public interface of Libtask.jl.
1010
They divide neatly into two kinds of functions: those which are used to manipulate
1111
[`TapedTask`](@ref)s, and those which are intended to be used _inside_ a
1212
[`TapedTask`](@ref).
13-
First, manipulation of [`TapedTask`](@ref)s:
13+
14+
## Manipulation of [`TapedTask`](@ref)s:
1415
```@docs; canonical=true
1516
Libtask.consume
1617
Base.copy(::Libtask.TapedTask)
1718
Libtask.set_taped_globals!
19+
```
20+
21+
An opt-in mechanism marks functions that might contain `Libtask.produce` statements.
22+
23+
```@docs; canonical=true
1824
Libtask.might_produce(::Type{<:Tuple})
1925
```
2026

21-
Functions for use inside a [`TapedTask`](@ref)s are:
27+
## Functions for use inside a [`TapedTask`](@ref)s:
2228
```@docs; canonical=true
2329
Libtask.produce
2430
Libtask.get_taped_globals

0 commit comments

Comments
 (0)