Fix TimerTask :execution_interval docs

freemanoid · eregon · commit 9f40827be9a8 · 2023-04-24T20:04:53.000+02:00
This seems to be a mistake in the docs. Looking under the hood at the `ScheduledTask` class, you can see that Float is perfectly fine and can be passed as an execution interval. This PR changes `Integer` to `Float` in the method description to avoid any confusion. https://github.com/ruby-concurrency/concurrent-ruby/blob/e7ff945661a93a2e094b3259f23ccb1b3eea9bcf/lib/concurrent-ruby/concurrent/scheduled_task.rb#L167
diff --git a/lib/concurrent-ruby/concurrent/timer_task.rb b/lib/concurrent-ruby/concurrent/timer_task.rb
@@ -159,7 +159,7 @@ class TimerTask < RubyExecutorService
     #
     # @!macro timer_task_initialize
     #   @param [Hash] opts the options defining task execution.
-    #   @option opts [Integer] :execution_interval number of seconds between
+    #   @option opts [Float] :execution_interval number of seconds between
     #     task executions (default: EXECUTION_INTERVAL)
     #   @option opts [Boolean] :run_now Whether to run the task immediately
     #     upon instantiation or to wait until the first #  execution_interval

Original file line number	Diff line number	Diff line change
`@@ -159,7 +159,7 @@ class TimerTask < RubyExecutorService`
`159`	`159`	`#`
`160`	`160`	`# @!macro timer_task_initialize`
`161`	`161`	`# @param [Hash] opts the options defining task execution.`
`162`		`- # @option opts [Integer] :execution_interval number of seconds between`
	`162`	`+ # @option opts [Float] :execution_interval number of seconds between`
`163`	`163`	`# task executions (default: EXECUTION_INTERVAL)`
`164`	`164`	`# @option opts [Boolean] :run_now Whether to run the task immediately`
`165`	`165`	`# upon instantiation or to wait until the first # execution_interval`