Code examples for List#merge, #merge_by

lib/hamster/list.rb

@@ -795,6 +795,12 @@ def indices(object = Undefined, i = 0, &block)
     # determined to be "lowest" according to the comparator will be the first in
     # the merged `List`.
     #
+    # @example
+    #   list_1 = Hamster::List[1, -3, -5]
+    #   list_2 = Hamster::List[-2, 4, 6]
+    #   Hamster::List[list_1, list_2].merge { |a,b| a.abs <=> b.abs }
+    #   # => Hamster::List[1, -2, -3, 4, -5, 6]
+    #
     # @return [List]
     def merge(&comparator)
       return merge_by unless block_given?
@@ -813,6 +819,12 @@ def merge(&comparator)
     # list. Whichever nested list's `#head` has the "lowest" sort key (according to
     # their natural order) will be the first in the merged `List`.
     #
+    # @example
+    #   list_1 = Hamster::List[1, -3, -5]
+    #   list_2 = Hamster::List[-2, 4, 6]
+    #   Hamster::List[list_1, list_2].merge_by { |x| x.abs }
+    #   # => Hamster::List[1, -2, -3, 4, -5, 6]
+    #
     # @return [List]
     def merge_by(&transformer)
       return merge_by { |item| item } unless block_given?