Skip to content

Commit 518a4b0

Browse files
committed
Update docs for Documenter v1
1 parent 3d76232 commit 518a4b0

File tree

4 files changed

+13
-3
lines changed

4 files changed

+13
-3
lines changed

Diff for: docs/Project.toml

+3
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,6 @@ Dagger = "d58978e5-989f-55fb-8d15-ea34adc7bf54"
33
DaggerWebDash = "cfc5aa84-1a2a-41ab-b391-ede92ecae40c"
44
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
55
TimespanLogging = "a526e669-04d3-4846-9525-c66122c55f63"
6+
7+
[compat]
8+
Documenter = "1"

Diff for: docs/make.jl

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
using Dagger, TimespanLogging, DaggerWebDash
22
using Documenter
3+
import Documenter.Remotes: GitHub
34

45
makedocs(;
56
modules = [Dagger, TimespanLogging, DaggerWebDash],
67
authors = "JuliaParallel and contributors",
7-
repo = "https://github.com/JuliaParallel/Dagger.jl/blob/{commit}{path}#L{line}",
8+
repo = GitHub("JuliaParallel", "Dagger.jl"),
89
sitename = "Dagger.jl",
910
format = Documenter.HTML(;
1011
prettyurls = get(ENV, "CI", "false") == "true",
@@ -42,7 +43,8 @@ makedocs(;
4243
"Types" => "api-daggerwebdash/types.md",
4344
"Functions and Macros" => "api-daggerwebdash/functions.md",
4445
],
45-
]
46+
],
47+
warnonly=[:missing_docs]
4648
)
4749

4850
deploydocs(;

Diff for: docs/src/api-dagger/functions.md

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ default_option
2626
## Data Management Functions
2727
```@docs
2828
tochunk
29+
mutable
2930
@mutable
3031
@shard
3132
shard

Diff for: src/chunks.jl

+5-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,6 @@ end
122122

123123
"""
124124
mutable(f::Base.Callable; worker, processor, scope) -> Chunk
125-
@mutable [worker=1] [processor=OSProc()] [scope=ProcessorScope()] f()
126125
127126
Calls `f()` on the specified worker or processor, returning a `Chunk`
128127
referencing the result with the specified scope `scope`.
@@ -143,6 +142,11 @@ function mutable(@nospecialize(f); worker=nothing, processor=nothing, scope=noth
143142
return fetch(Dagger.@spawn scope=scope _mutable_inner(f, processor, scope))[]
144143
end
145144

145+
"""
146+
@mutable [worker=1] [processor=OSProc()] [scope=ProcessorScope()] f()
147+
148+
Helper macro for [`mutable()`](@ref).
149+
"""
146150
macro mutable(exs...)
147151
opts = esc.(exs[1:end-1])
148152
ex = exs[end]

0 commit comments

Comments
 (0)