1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add some documentation to Timeout#timeout about possible issues

Browse Source 
Documentation requested in [Bug #15886].
This commit is contained in:
Jeremy Evans 2019-06-04 19:19:37 -07:00
parent a105831819
commit 96d6527424
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lib/timeout.rb
View File

@ -67,7 +67,9 @@ module Timeout
# +sec+ seconds, otherwise throws an exception, based on the value of +klass+. # +sec+ seconds, otherwise throws an exception, based on the value of +klass+.
# #
# The exception thrown to terminate the given block cannot be rescued inside # The exception thrown to terminate the given block cannot be rescued inside
# the block unless +klass+ is given explicitly. # the block unless +klass+ is given explicitly. However, the block can use
# ensure to prevent the handling of the exception. For that reason, this
# method cannot be relied on to enforce timeouts for untrusted blocks.
# #
# Note that this is both a method of module Timeout, so you can <tt>include # Note that this is both a method of module Timeout, so you can <tt>include
# Timeout</tt> into your classes so they have a #timeout method, as well as # Timeout</tt> into your classes so they have a #timeout method, as well as