Skip to content

Commit

Permalink
Link parallel processing tutorial from docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
tkf committed Dec 15, 2019
1 parent b719bb6 commit 32961df
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 2 deletions.
2 changes: 1 addition & 1 deletion examples/tutorial_parallel.jl
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ catch err; err; end # hide
# (see: [Splitting a string into words and counting them in
# parallel](@ref parallel-word-count)).

# ## Example: parallel `collect`
# ## [Example: parallel `collect`](@id tutorial-parallel-collect)
#
# !!! note
# This section explains the _implementation ideas_ of parallel
Expand Down
9 changes: 9 additions & 0 deletions src/dreduce.jl
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ supported yet.
Use [`dcollect`](@ref) or [`dcopy`](@ref) to collect results into a
container.
See also: [Parallel processing tutorial](@ref tutorial-parallel),
[`foldl`](@ref), [`reduce`](@ref).
!!! compat "Transducers.jl 0.4.3"
New in version 0.4.3.
Expand Down Expand Up @@ -86,6 +89,9 @@ Distributed.jl-based parallel version of [`copy`](@ref). Keyword
arguments are passed to [`dreduce`](@ref). For examples, see
[`tcopy`](@ref).
See also: [Parallel processing tutorial](@ref tutorial-parallel)
(especially [Example: parallel `collect`](@ref tutorial-parallel-collect)).
!!! compat "Transducers.jl 0.4.5"
New in version 0.4.5.
Expand All @@ -101,6 +107,9 @@ Distributed.jl-based parallel version of [`collect`](@ref).
This is just a short-hand notation of `dcopy(xf, Vector, reducible)`.
Use [`dcopy`](@ref) to get a container other than a `Vector`.
See also: [Parallel processing tutorial](@ref tutorial-parallel)
(especially [Example: parallel `collect`](@ref tutorial-parallel-collect)).
!!! compat "Transducers.jl 0.4.5"
New in version 0.4.5.
Expand Down
9 changes: 8 additions & 1 deletion src/reduce.jl
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ theory). Early termination requires Julia ≥ 1.3.
Use [`tcollect`](@ref) or [`tcopy`](@ref) to collect results into a
container.
See [`foldl`](@ref), [`dreduce`](@ref).
See also: [Parallel processing tutorial](@ref tutorial-parallel),
[`foldl`](@ref), [`dreduce`](@ref).
# Keyword Arguments
- `basesize::Integer = length(reducible) ÷ nthreads()`: A size of
Expand Down Expand Up @@ -197,6 +198,9 @@ Base.reduce(step, xform::Transducer, itr; kwargs...) =
Thread-based parallel version of [`copy`](@ref).
Keyword arguments are passed to [`reduce`](@ref).
See also: [Parallel processing tutorial](@ref tutorial-parallel)
(especially [Example: parallel `collect`](@ref tutorial-parallel-collect)).
!!! compat "Transducers.jl 0.4.5"
New in version 0.4.5.
Expand Down Expand Up @@ -273,6 +277,9 @@ Thread-based parallel version of [`collect`](@ref).
This is just a short-hand notation of `tcopy(xf, Vector, reducible)`.
Use [`tcopy`](@ref) to get a container other than a `Vector`.
See also: [Parallel processing tutorial](@ref tutorial-parallel)
(especially [Example: parallel `collect`](@ref tutorial-parallel-collect)).
!!! compat "Transducers.jl 0.4.5"
New in version 0.4.5.
Expand Down

0 comments on commit 32961df

Please sign in to comment.