Skip to content

Commit bde142f

Browse files
committed
Placeholder docstring for produce
1 parent 4d0b423 commit bde142f

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/copyable_task.jl

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@ See also [`set_dynamic_scope!`](@ref).
1111
get_dynamic_scope() = dynamic_scope[]
1212

1313
__v::Int = 5
14+
15+
"""
16+
produce(x)
17+
18+
When run inside a [`TapedTask`](@ref), will immediately yield to the caller, producing value
19+
`x`.
20+
21+
See also: [`Libtask.consume`](@ref)
22+
"""
1423
@noinline function produce(x)
1524
global __v = 4
1625
return nothing

0 commit comments

Comments
 (0)