Skip to content

Commit 764fe23

Browse files
Add missing documentation.
1 parent 6e70d73 commit 764fe23

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

lib/async/safe/builtins.rb

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@
1212
class Array
1313
ASYNC_SAFE = false
1414

15+
# Traverse array elements during ownership transfer.
16+
#
17+
# @parameter instance [Array] The array instance to traverse.
18+
# @parameter block [Proc] Block to call for each element.
1519
def self.async_safe_traverse(instance, &block)
1620
instance.each(&block)
1721
end
@@ -21,6 +25,10 @@ def self.async_safe_traverse(instance, &block)
2125
class Hash
2226
ASYNC_SAFE = false
2327

28+
# Traverse hash keys and values during ownership transfer.
29+
#
30+
# @parameter instance [Hash] The hash instance to traverse.
31+
# @parameter block [Proc] Block to call for each key and value.
2432
def self.async_safe_traverse(instance, &block)
2533
instance.each_key(&block)
2634
instance.each_value(&block)
@@ -31,6 +39,10 @@ def self.async_safe_traverse(instance, &block)
3139
class Set
3240
ASYNC_SAFE = false
3341

42+
# Traverse set elements during ownership transfer.
43+
#
44+
# @parameter instance [Set] The set instance to traverse.
45+
# @parameter block [Proc] Block to call for each element.
3446
def self.async_safe_traverse(instance, &block)
3547
instance.each(&block)
3648
end

0 commit comments

Comments
 (0)