Skip to content

Mark Libtask.might_produce public. #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 27, 2025
Merged

Mark Libtask.might_produce public. #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f77bb51
Update index.md
yebai May 27, 2025
eb21b00
Update internals.md
yebai May 27, 2025
f89a548
Update Project.toml
yebai May 27, 2025
8f6d1d3
Update index.md
yebai May 27, 2025
a90cbe7
Update index.md
yebai May 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ uuid = "6f1fad26-d15e-5dc8-ae53-837a1d7b8c9f"
license = "MIT"
desc = "Tape based task copying in Turing"
repo = "https://github.com/TuringLang/Libtask.jl.git"
version = "0.9.0"
version = "0.9.1"

[deps]
MistyClosures = "dbe65cb8-6be2-42dd-bbc5-4196aaced4f4"
Expand Down
11 changes: 9 additions & 2 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,22 @@ public interface of Libtask.jl.
They divide neatly into two kinds of functions: those which are used to manipulate
[`TapedTask`](@ref)s, and those which are intended to be used _inside_ a
[`TapedTask`](@ref).
First, manipulation of [`TapedTask`](@ref)s:

## Manipulation of [`TapedTask`](@ref)s:
```@docs; canonical=true
Libtask.consume
Base.copy(::Libtask.TapedTask)
Libtask.set_taped_globals!
```

Functions for use inside a [`TapedTask`](@ref)s are:
## Functions for use inside a [`TapedTask`](@ref)s:
```@docs; canonical=true
Libtask.produce
Libtask.get_taped_globals
```

An opt-in mechanism marks functions that might contain `Libtask.produce` statements.

```@docs; canonical=true
Libtask.might_produce(::Type{<:Tuple})
```
1 change: 0 additions & 1 deletion docs/src/internals.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
```@docs; canonical=true
Libtask.produce_value
Libtask.is_produce_stmt
Libtask.might_produce
Libtask.stmt_might_produce
Libtask.inc_args
Libtask.get_type
Expand Down
Loading