Doc update

Author: pitr-ch

docs-source/channel.out.md

@@ -45,7 +45,7 @@ threads
 ch.push message: 3
 # => #<Concurrent::Promises::Channel:0x000002 capacity taken 0 of 2>
 threads.map(&:value)
-# => [{:message=>1}, {:message=>2}, {:message=>3}]
+# => [{:message=>2}, {:message=>1}, {:message=>3}]
 ```
 
 ### Promises integration
@@ -57,8 +57,8 @@ therefore all operations can be represented as futures.
 ch = Concurrent::Promises::Channel.new 2
 # => #<Concurrent::Promises::Channel:0x000009 capacity taken 0 of 2>
 push_operations = Array.new(3) { |i| ch.push_op message: i }
-# => [#<Concurrent::Promises::Future:0x00000a fulfilled>,
-#     #<Concurrent::Promises::Future:0x00000b fulfilled>,
+# => [#<Concurrent::Promises::Future:0x00000a fulfilled with #<Concurrent::Promises::Channel:0x000009 capacity taken 2 of 2>>,
+#     #<Concurrent::Promises::Future:0x00000b fulfilled with #<Concurrent::Promises::Channel:0x000009 capacity taken 2 of 2>>,
 #     #<Concurrent::Promises::ResolvableFuture:0x00000c pending>]
 ```
 
@@ -78,8 +78,8 @@ push_operations.map(&:value!)
 #     #<Concurrent::Promises::Channel:0x000009 capacity taken 2 of 2>]
 
 pop_operations = Array.new(3) { |i| ch.pop_op }
-# => [#<Concurrent::Promises::ResolvableFuture:0x00000d fulfilled>,
-#     #<Concurrent::Promises::ResolvableFuture:0x00000e fulfilled>,
+# => [#<Concurrent::Promises::ResolvableFuture:0x00000d fulfilled with {:message=>1}>,
+#     #<Concurrent::Promises::ResolvableFuture:0x00000e fulfilled with {:message=>2}>,
 #     #<Concurrent::Promises::ResolvableFuture:0x00000f pending>]
 ch.push message: 3 # (push|pop) can be freely mixed with (push_o|pop_op)
 pop_operations.map(&:value) 
@@ -148,7 +148,7 @@ ch.push 2, 0.01                          # => true
 ch.push 3, 0.01                          # => false
 ch.pop 0.01                              # => 1
 ch.pop 0.01                              # => 2
-ch.pop 0.01                              # => [true, nil, nil]
+ch.pop 0.01                              # => nil
 ```
 
 ### Backpressure
@@ -204,17 +204,17 @@ log
 #     "producer 0 pushing 2",
 #     "producer 1 pushing 0",
 #     "consumer 0 got 0. payload 0 from producer 0",
+#     "consumer 1 got 0. payload 1 from producer 0",
+#     "consumer 2 got 0. payload 2 from producer 0",
+#     "consumer 3 got 0. payload 0 from producer 1",
 #     "producer 0 pushing 3",
-#     "consumer 2 got 0. payload 1 from producer 0",
-#     "consumer 3 got 0. payload 2 from producer 0",
-#     "consumer 1 got 0. payload 0 from producer 1",
 #     "producer 1 pushing 1",
 #     "producer 1 pushing 2",
-#     "consumer 2 got 1. payload 3 from producer 0",
-#     "consumer 3 got 1. payload 1 from producer 1",
-#     "consumer 1 got 1. payload 2 from producer 1",
+#     "consumer 0 got 1. payload 3 from producer 0",
+#     "consumer 1 got 1. payload 1 from producer 1",
+#     "consumer 2 got 1. payload 2 from producer 1",
 #     "producer 1 pushing 3",
-#     "consumer 0 got 1. payload 3 from producer 1"]
+#     "consumer 3 got 1. payload 3 from producer 1"]
 ```
 
 The producers are much faster than consumers 
@@ -269,20 +269,20 @@ consumers.map(&:value!)                  # => [:done, :done, :done, :done]
 log
 # => ["producer 0 pushing 0",
 #     "producer 1 pushing 0",
-#     "consumer 0 got 0. payload 0 from producer 0",
 #     "producer 0 pushing 1",
 #     "producer 1 pushing 1",
-#     "consumer 2 got 0. payload 0 from producer 1",
-#     "consumer 3 got 0. payload 1 from producer 0",
+#     "consumer 0 got 0. payload 0 from producer 0",
+#     "consumer 1 got 0. payload 0 from producer 1",
+#     "consumer 2 got 0. payload 1 from producer 0",
 #     "producer 0 pushing 2",
-#     "producer 0 pushing 3",
-#     "consumer 1 got 0. payload 1 from producer 1",
+#     "consumer 3 got 0. payload 1 from producer 1",
 #     "producer 1 pushing 2",
+#     "producer 0 pushing 3",
 #     "producer 1 pushing 3",
+#     "consumer 3 got 1. payload 3 from producer 1",
 #     "consumer 0 got 1. payload 2 from producer 0",
-#     "consumer 3 got 1. payload 3 from producer 0",
-#     "consumer 2 got 1. payload 2 from producer 1",
-#     "consumer 1 got 1. payload 3 from producer 1"]
+#     "consumer 1 got 1. payload 2 from producer 1",
+#     "consumer 2 got 1. payload 3 from producer 0"]
 ```
 
 ### Synchronization of workers by passing a value
@@ -309,5 +309,5 @@ thread.value                             # => :v1
 # the push operation resolves as a pairing pop is called
 channel.pop                              # => :v2
 push
-# => #<Concurrent::Promises::ResolvableFuture:0x000023 fulfilled>
+# => #<Concurrent::Promises::ResolvableFuture:0x000023 fulfilled with #<Concurrent::Promises::Channel:0x000021 capacity taken 0 of 0>>
 ```

docs-source/promises.out.md

@@ -218,13 +218,13 @@ Instead, it can be created directly as already-resolved:
 
 ```ruby
 Concurrent::Promises.fulfilled_future(:value)
-# => #<Concurrent::Promises::Future:0x000008 fulfilled>
+# => #<Concurrent::Promises::Future:0x000008 fulfilled with :value>
 Concurrent::Promises.rejected_future(StandardError.new('Ups'))
-# => #<Concurrent::Promises::Future:0x000009 rejected>
+# => #<Concurrent::Promises::Future:0x000009 rejected with #<StandardError: Ups>>
 Concurrent::Promises.resolved_future(true, :value, nil)
-# => #<Concurrent::Promises::Future:0x00000a fulfilled>
+# => #<Concurrent::Promises::Future:0x00000a fulfilled with :value>
 Concurrent::Promises.resolved_future(false, nil, StandardError.new('Ups'))
-# => #<Concurrent::Promises::Future:0x00000b rejected>
+# => #<Concurrent::Promises::Future:0x00000b rejected with #<StandardError: Ups>>
 ```
 
 ## Chaining
@@ -388,7 +388,7 @@ Zip is rejected if any of the zipped futures is.
 rejected_zip = Concurrent::Promises.zip(
     Concurrent::Promises.fulfilled_future(1),
     Concurrent::Promises.rejected_future(StandardError.new('Ups')))
-# => #<Concurrent::Promises::Future:0x000011 rejected>
+# => #<Concurrent::Promises::Future:0x000011 rejected with [nil, #<StandardError: Ups>]>
 rejected_zip.result
 # => [false, [1, nil], [nil, #<StandardError: Ups>]]
 rejected_zip.
@@ -531,7 +531,7 @@ The thread will be blocked until the future is resolved
 ```ruby
 thread = Thread.new { future.value } 
 future.fulfill 1
-# => #<Concurrent::Promises::ResolvableFuture:0x000015 fulfilled>
+# => #<Concurrent::Promises::ResolvableFuture:0x000015 fulfilled with 1>
 thread.value                             # => 1
 ```
 
@@ -667,14 +667,14 @@ more messages.
 
 ```ruby
 pushes = 3.times.map { |i| ch1.push_op i }
-# => [#<Concurrent::Promises::Future:0x00001b fulfilled>,
-#     #<Concurrent::Promises::Future:0x00001c fulfilled>,
+# => [#<Concurrent::Promises::Future:0x00001b fulfilled with #<Concurrent::Promises::Channel:0x00001a capacity taken 2 of 2>>,
+#     #<Concurrent::Promises::Future:0x00001c fulfilled with #<Concurrent::Promises::Channel:0x00001a capacity taken 2 of 2>>,
 #     #<Concurrent::Promises::ResolvableFuture:0x00001d pending>]
 ch1.pop_op.value!                        # => 0
 pushes
-# => [#<Concurrent::Promises::Future:0x00001b fulfilled>,
-#     #<Concurrent::Promises::Future:0x00001c fulfilled>,
-#     #<Concurrent::Promises::ResolvableFuture:0x00001d fulfilled>]
+# => [#<Concurrent::Promises::Future:0x00001b fulfilled with #<Concurrent::Promises::Channel:0x00001a capacity taken 2 of 2>>,
+#     #<Concurrent::Promises::Future:0x00001c fulfilled with #<Concurrent::Promises::Channel:0x00001a capacity taken 2 of 2>>,
+#     #<Concurrent::Promises::ResolvableFuture:0x00001d fulfilled with #<Concurrent::Promises::Channel:0x00001a capacity taken 2 of 2>>]
 ```
 
 A selection over channels can be created with the `.select_channel` factory method. It
@@ -685,7 +685,7 @@ returns a pair to be able to find out which channel had the message available.
 ch2    = Concurrent::Promises::Channel.new 2
 # => #<Concurrent::Promises::Channel:0x00001e capacity taken 0 of 2>
 result = Concurrent::Promises::Channel.select_op([ch1, ch2])
-# => #<Concurrent::Promises::ResolvableFuture:0x00001f fulfilled>
+# => #<Concurrent::Promises::ResolvableFuture:0x00001f fulfilled with [#<Concurrent::Promises::Channel:0x00001a capacity taken 1 of 2>, 1]>
 result.value!
 # => [#<Concurrent::Promises::Channel:0x00001a capacity taken 1 of 2>, 1]
 
@@ -780,7 +780,7 @@ end
 # => #<Proc:[email protected]:662 (lambda)>
 
 Concurrent::Promises.future(actor, 0, &produce).run.wait!
-# => #<Concurrent::Promises::Future:0x00002e fulfilled>
+# => #<Concurrent::Promises::Future:0x00002e fulfilled with #<Concurrent::ProcessingActor:0x00002a @Mailbox=#<Concurrent::Promises::Channel:0x00002b capacity taken 2 of 2>, @Terminated=#<Concurrent::Promises::ResolvableFuture:0x00002c pending> termination:pending>>
 
 actor.termination.value!                 # => 45
 ```
@@ -1088,12 +1088,12 @@ Let it run for a while, then cancel it, and ensure that the runs were all fulfil
 origin.resolve
 # => #<Concurrent::Promises::ResolvableEvent:0x000044 resolved>
 query_processes.map(&:wait!) 
-# => [#<Concurrent::Promises::Future:0x00003f fulfilled>,
-#     #<Concurrent::Promises::Future:0x000040 fulfilled>,
-#     #<Concurrent::Promises::Future:0x000041 fulfilled>]
+# => [#<Concurrent::Promises::Future:0x00003f fulfilled with nil>,
+#     #<Concurrent::Promises::Future:0x000040 fulfilled with nil>,
+#     #<Concurrent::Promises::Future:0x000041 fulfilled with nil>]
 word_counter_processes.map(&:wait!)
-# => [#<Concurrent::Promises::Future:0x000042 fulfilled>,
-#     #<Concurrent::Promises::Future:0x000043 fulfilled>]
+# => [#<Concurrent::Promises::Future:0x000042 fulfilled with nil>,
+#     #<Concurrent::Promises::Future:0x000043 fulfilled with nil>]
 words                                    # => [7, 7, 7, 7]
 ```
 

docs/master/Concurrent/Promises.html

@@ -2266,7 +2266,7 @@ <h3 class="signature " id="rejected_future-class_method">
         <span class='name'>reason</span>
 
 
-        <span class='type'>(<tt>Exception</tt>)</span>
+        <span class='type'>(<tt>Object</tt>)</span>
 
 
 
@@ -2630,7 +2630,7 @@ <h3 class="signature " id="resolved_future-class_method">
         <span class='name'>reason</span>
 
 
-        <span class='type'>(<tt>Exception</tt>)</span>
+        <span class='type'>(<tt>Object</tt>)</span>
 
 
 

docs/master/Concurrent/Promises/AbstractEventFuture.html

@@ -667,7 +667,7 @@ <h3 class="signature " id="chain_on-instance_method">
         <span class='name'>reason</span>
 
 
-        <span class='type'>(<tt>Exception</tt>)</span>
+        <span class='type'>(<tt>Object</tt>)</span>
 
 
 
@@ -1143,7 +1143,7 @@ <h3 class="signature " id="on_resolution!-instance_method">
         <span class='name'>reason</span>
 
 
-        <span class='type'>(<tt>Exception</tt>)</span>
+        <span class='type'>(<tt>Object</tt>)</span>
 
 
 
@@ -1343,7 +1343,7 @@ <h3 class="signature " id="on_resolution_using-instance_method">
         <span class='name'>reason</span>
 
 
-        <span class='type'>(<tt>Exception</tt>)</span>
+        <span class='type'>(<tt>Object</tt>)</span>