Skip to content

Commit 7fa7e82

Browse files
committed
Fix documentation
1 parent bf824c9 commit 7fa7e82

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

lib/concurrent-ruby/concurrent/executor/fixed_thread_pool.rb

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ module Concurrent
1616
# Default maximum number of seconds a thread in the pool may remain idle
1717
# before being reclaimed.
1818

19+
# @!macro thread_pool_executor_constant_default_synchronous
20+
# Default value of the :synchronous option.
21+
1922
# @!macro thread_pool_executor_attr_reader_max_length
2023
# The maximum number of threads that may be created in the pool.
2124
# @return [Integer] The maximum number of threads that may be created in the pool.
@@ -40,6 +43,10 @@ module Concurrent
4043
# The number of seconds that a thread may be idle before being reclaimed.
4144
# @return [Integer] The number of seconds that a thread may be idle before being reclaimed.
4245

46+
# @!macro thread_pool_executor_attr_reader_synchronous
47+
# Whether or not a value of 0 for :max_queue option means the queue must perform direct hand-off or rather unbounded queue.
48+
# @return [true, false]
49+
4350
# @!macro thread_pool_executor_attr_reader_max_queue
4451
# The maximum number of tasks that may be waiting in the work queue at any one time.
4552
# When the queue size reaches `max_queue` subsequent tasks will be rejected in

lib/concurrent-ruby/concurrent/executor/thread_pool_executor.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ class ThreadPoolExecutor < ThreadPoolExecutorImplementation
7373
# @option opts [Symbol] :fallback_policy (:abort) the policy for handling new
7474
# tasks that are received when the queue size has reached
7575
# `max_queue` or the executor has shut down
76-
# @options opts [Boolean] :synchronous (DEFAULT_SYNCHRONOUS) whether or not a value of 0
76+
# @option opts [Boolean] :synchronous (DEFAULT_SYNCHRONOUS) whether or not a value of 0
7777
# for :max_queue means the queue must perform direct hand-off rather than unbounded.
7878
# @raise [ArgumentError] if `:max_threads` is less than one
7979
# @raise [ArgumentError] if `:min_threads` is less than zero

0 commit comments

Comments
 (0)