Skip to content

Commit 77c1971

Browse files
committed
Minor documentation updates to Agent.
1 parent 1a4b8f8 commit 77c1971

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

lib/concurrent/agent.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,15 @@ class Agent
4646
#
4747
# @param [Object] initial the initial value
4848
# @param [Hash] opts the options used to define the behavior at update and deref
49+
#
4950
# @option opts [Fixnum] :timeout (TIMEOUT) maximum number of seconds before an update is cancelled
51+
#
5052
# @option opts [Boolean] :operation (false) when +true+ will execute the future on the global
5153
# operation pool (for long-running operations), when +false+ will execute the future on the
5254
# global task pool (for short-running tasks)
5355
# @option opts [object] :executor when provided will run all operations on
5456
# this executor rather than the global thread pool (overrides :operation)
57+
#
5558
# @option opts [String] :dup_on_deref (false) call +#dup+ before returning the data
5659
# @option opts [String] :freeze_on_deref (false) call +#freeze+ before returning the data
5760
# @option opts [String] :copy_on_deref (nil) call the given +Proc+ passing the internal value and

0 commit comments

Comments
 (0)