summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/worker_pool.erl4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/worker_pool.erl b/src/worker_pool.erl
index eb8c1dc6b8..71359aa5ed 100644
--- a/src/worker_pool.erl
+++ b/src/worker_pool.erl
@@ -22,6 +22,10 @@
%% (using worker_pool:submit/1, worker_pool:submit/2) or synchronously
%% (using worker_pool:submit_async/1).
%%
+%% We typically use the worker pool if we want to limit the maximum
+%% parallelism of some job. We are not trying to dodge the cost of
+%% creating Erlang processes.
+%%
%% Supports nested submission of jobs and two execution modes:
%% 'single' and 'reuse'. Jobs executed in 'single' mode are invoked in
%% a one-off process. Those executed in 'reuse' mode are invoked in a