Skip to content

Commit 491dac9

Browse files
authored
Fix some docstring typos (schedule -> scheduler) (#123)
1 parent af70b5d commit 491dac9

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/functions.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ function treduce end
135135

136136
"""
137137
tforeach(f, A::AbstractArray...;
138-
[schedule::Union{Scheduler, Symbol} = :dynamic]) :: Nothing
138+
[scheduler::Union{Scheduler, Symbol} = :dynamic]) :: Nothing
139139
140140
A multithreaded function like `Base.foreach`. Apply `f` to each element of `A` on
141141
multiple parallel tasks, and return `nothing`. I.e. it is the parallel equivalent of
@@ -174,7 +174,7 @@ function tforeach end
174174

175175
"""
176176
tmap(f, [OutputElementType], A::AbstractArray...;
177-
[schedule::Union{Scheduler, Symbol} = :dynamic])
177+
[scheduler::Union{Scheduler, Symbol} = :dynamic])
178178
179179
A multithreaded function like `Base.map`. Create a new container `similar` to `A` and fills
180180
it in parallel such that the `i`th element is equal to `f(A[i])`.
@@ -207,7 +207,7 @@ function tmap end
207207

208208
"""
209209
tmap!(f, out, A::AbstractArray...;
210-
[schedule::Union{Scheduler, Symbol} = :dynamic])
210+
[scheduler::Union{Scheduler, Symbol} = :dynamic])
211211
212212
A multithreaded function like `Base.map!`. In parallel on multiple tasks, this function
213213
assigns each element of `out[i] = f(A[i])` for each index `i` of `A` and `out`.
@@ -225,7 +225,7 @@ function tmap! end
225225

226226
"""
227227
tcollect([OutputElementType], gen::Union{AbstractArray, Generator{<:AbstractArray}};
228-
[schedule::Union{Scheduler, Symbol} = :dynamic])
228+
[scheduler::Union{Scheduler, Symbol} = :dynamic])
229229
230230
A multithreaded function like `Base.collect`. Essentially just calls `tmap` on the
231231
generator function and inputs.

0 commit comments

Comments
 (0)