doc AbstractWorkerPool

JuliaLang · Apr 9, 2019 · 6cbd7a8 · 6cbd7a8
1 parent 1b57e3a
commit 6cbd7a8
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 13 deletions.
diff --git a/stdlib/Distributed/docs/src/index.md b/stdlib/Distributed/docs/src/index.md
@@ -29,6 +29,7 @@ Distributed.put!(::Future, ::Any)
 Distributed.take!(::RemoteChannel, ::Any...)
 Distributed.isready(::RemoteChannel, ::Any...)
 Distributed.isready(::Future)
+Distributed.AbstractWorkerPool
 Distributed.WorkerPool
 Distributed.CachingPool
 Distributed.default_worker_pool

diff --git a/stdlib/Distributed/src/workerpool.jl b/stdlib/Distributed/src/workerpool.jl
@@ -1,19 +1,22 @@
 # This file is a part of Julia. License is MIT: https://julialang.org/license
 
-abstract type AbstractWorkerPool end
+"""
+    AbstractWorkerPool
 
-# An AbstractWorkerPool should implement
-#
-# `push!` - add a new worker to the overall pool (available + busy)
-# `put!` - put back a worker to the available pool
-# `take!` - take a worker from the available pool (to be used for remote function execution)
-# `length` - number of workers available in the overall pool
-# `isready` - return false if a `take!` on the pool would block, else true
-#
-# The default implementations of the above (on a AbstractWorkerPool) require fields
-#    channel::Channel{Int}
-#    workers::Set{Int}
-#
+Supertype for worker pools such as [`WorkerPool`](@ref) and [`CachingPool`](@ref).
+An `AbstractWorkerPool` should implement:
+  - [`push!`](@ref) - add a new worker to the overall pool (available + busy)
+  - [`put!`](@ref) - put back a worker to the available pool
+  - [`take!`](@ref) - take a worker from the available pool (to be used for remote function execution)
+  - [`length`](@ref) - number of workers available in the overall pool
+  - [`isready`](@ref) - return false if a `take!` on the pool would block, else true
+
+The default implementations of the above (on a `AbstractWorkerPool`) require fields
+    channel::Channel{Int}
+    workers::Set{Int}
+where `channel` contains free worker pids and `workers` is the set of all workers associated with this pool.
+"""
+abstract type AbstractWorkerPool end
 
 mutable struct WorkerPool <: AbstractWorkerPool
     channel::Channel{Int}