Skip to content

Commit 2fe0495

Browse files
committed
Add documentation to InterruptHandler
1 parent 565d7bf commit 2fe0495

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

lib/overcommit/interrupt_handler.rb

+6
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ class InterruptHandler
77

88
attr_accessor :isolate_signals, :signal_received, :reenable_on_interrupt
99

10+
# Initialize safe interrupt signal handling.
1011
def initialize
1112
self.isolate_signals = false
1213
self.signal_received = false
@@ -64,14 +65,19 @@ def disable_until_finished_or_interrupted
6465
instance.isolate_signals = true
6566
end
6667

68+
# Disable interrupt isolation.
6769
def disable!
6870
instance.isolate_signals = false
6971
end
7072

73+
# Enable interrupt isolation.
7174
def enable!
7275
instance.isolate_signals = true
7376
end
7477

78+
# Enable interrupt isolation while executing the provided block.
79+
#
80+
# @yield block to execute with interrupt isolation
7581
def isolate_from_interrupts
7682
instance.signal_received = false
7783
instance.isolate_signals = true

0 commit comments

Comments
 (0)