Skip to content

Commit 2eac362

Browse files
committed
Doc update
1 parent 35322e4 commit 2eac362

File tree

9 files changed

+2528
-1121
lines changed

9 files changed

+2528
-1121
lines changed

docs-source/channel.out.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ threads
4545
ch.push message: 3
4646
# => #<Concurrent::Promises::Channel:0x000002 capacity taken 0 of 2>
4747
threads.map(&:value)
48-
# => [{:message=>2}, {:message=>1}, {:message=>3}]
48+
# => [{:message=>1}, {:message=>2}, {:message=>3}]
4949
```
5050

5151
### Promises integration
@@ -210,11 +210,11 @@ log
210210
# "producer 0 pushing 3",
211211
# "producer 1 pushing 1",
212212
# "producer 1 pushing 2",
213-
# "consumer 0 got 1. payload 3 from producer 0",
214-
# "consumer 1 got 1. payload 1 from producer 1",
215-
# "consumer 2 got 1. payload 2 from producer 1",
213+
# "consumer 1 got 1. payload 3 from producer 0",
214+
# "consumer 0 got 1. payload 1 from producer 1",
215+
# "consumer 3 got 1. payload 2 from producer 1",
216216
# "producer 1 pushing 3",
217-
# "consumer 3 got 1. payload 3 from producer 1"]
217+
# "consumer 2 got 1. payload 3 from producer 1"]
218218
```
219219

220220
The producers are much faster than consumers
@@ -279,10 +279,10 @@ log
279279
# "producer 1 pushing 2",
280280
# "producer 0 pushing 3",
281281
# "producer 1 pushing 3",
282-
# "consumer 3 got 1. payload 3 from producer 1",
283282
# "consumer 0 got 1. payload 2 from producer 0",
284283
# "consumer 1 got 1. payload 2 from producer 1",
285-
# "consumer 2 got 1. payload 3 from producer 0"]
284+
# "consumer 2 got 1. payload 3 from producer 0",
285+
# "consumer 3 got 1. payload 3 from producer 1"]
286286
```
287287

288288
### Synchronization of workers by passing a value

docs/master/Concurrent/Actor.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -740,7 +740,7 @@ <h2>
740740
<li class="public ">
741741
<span class="summary_signature">
742742

743-
<a href="#current-class_method" title="current (class method)">.<strong>current</strong> &#x21d2; Reference<sup>?</sup> </a>
743+
<a href="#current-class_method" title="current (class method)">.<strong>current</strong> &#x21d2; Reference, nil </a>
744744

745745

746746

@@ -863,7 +863,7 @@ <h2>Class Method Details</h2>
863863
<div class="method_details first">
864864
<h3 class="signature first" id="current-class_method">
865865

866-
.<strong>current</strong> &#x21d2; <tt><span class='object_link'><a href="Actor/Reference.html" title="Concurrent::Actor::Reference (class)">Reference</a></span></tt><sup>?</sup>
866+
.<strong>current</strong> &#x21d2; <tt><span class='object_link'><a href="Actor/Reference.html" title="Concurrent::Actor::Reference (class)">Reference</a></span></tt>, <tt>nil</tt>
867867

868868

869869

docs/master/Concurrent/Actor/Core.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@ <h2>
418418
<li class="public ">
419419
<span class="summary_signature">
420420

421-
<a href="#behaviour-instance_method" title="#behaviour (instance method)">#<strong>behaviour</strong>(behaviour_class) &#x21d2; Behaviour::Abstract<sup>?</sup> </a>
421+
<a href="#behaviour-instance_method" title="#behaviour (instance method)">#<strong>behaviour</strong>(behaviour_class) &#x21d2; Behaviour::Abstract, nil </a>
422422

423423

424424

@@ -646,7 +646,7 @@ <h2>
646646
<li class="public ">
647647
<span class="summary_signature">
648648

649-
<a href="#parent-instance_method" title="#parent (instance method)">#<strong>parent</strong> &#x21d2; Reference<sup>?</sup> </a>
649+
<a href="#parent-instance_method" title="#parent (instance method)">#<strong>parent</strong> &#x21d2; Reference, nil </a>
650650

651651

652652

@@ -1608,7 +1608,7 @@ <h3 class="signature " id="allocate_context-instance_method">
16081608
<div class="method_details ">
16091609
<h3 class="signature " id="behaviour-instance_method">
16101610

1611-
#<strong>behaviour</strong>(behaviour_class) &#x21d2; <tt><span class='object_link'><a href="Behaviour/Abstract.html" title="Concurrent::Actor::Behaviour::Abstract (class)">Behaviour::Abstract</a></span></tt><sup>?</sup>
1611+
#<strong>behaviour</strong>(behaviour_class) &#x21d2; <tt><span class='object_link'><a href="Behaviour/Abstract.html" title="Concurrent::Actor::Behaviour::Abstract (class)">Behaviour::Abstract</a></span></tt>, <tt>nil</tt>
16121612

16131613

16141614

@@ -2109,7 +2109,7 @@ <h3 class="signature " id="on_envelope-instance_method">
21092109
<div class="method_details ">
21102110
<h3 class="signature " id="parent-instance_method">
21112111

2112-
#<strong>parent</strong> &#x21d2; <tt><span class='object_link'><a href="Reference.html" title="Concurrent::Actor::Reference (class)">Reference</a></span></tt><sup>?</sup>
2112+
#<strong>parent</strong> &#x21d2; <tt><span class='object_link'><a href="Reference.html" title="Concurrent::Actor::Reference (class)">Reference</a></span></tt>, <tt>nil</tt>
21132113

21142114

21152115

docs/master/Concurrent/Map.html

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ <h2>
157157
<li class="public ">
158158
<span class="summary_signature">
159159

160-
<a href="#compute-instance_method" title="#compute (instance method)">#<strong>compute</strong>(key) {|old_value| ... } &#x21d2; Object<sup>?</sup> </a>
160+
<a href="#compute-instance_method" title="#compute (instance method)">#<strong>compute</strong>(key) {|old_value| ... } &#x21d2; Object, nil </a>
161161

162162

163163

@@ -203,7 +203,7 @@ <h2>
203203
<li class="public ">
204204
<span class="summary_signature">
205205

206-
<a href="#compute_if_present-instance_method" title="#compute_if_present (instance method)">#<strong>compute_if_present</strong>(key) {|old_value| ... } &#x21d2; Object<sup>?</sup> </a>
206+
<a href="#compute_if_present-instance_method" title="#compute_if_present (instance method)">#<strong>compute_if_present</strong>(key) {|old_value| ... } &#x21d2; Object, nil </a>
207207

208208

209209

@@ -226,7 +226,7 @@ <h2>
226226
<li class="public ">
227227
<span class="summary_signature">
228228

229-
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(key) &#x21d2; Object<sup>?</sup> </a>
229+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(key) &#x21d2; Object, nil </a>
230230

231231

232232

@@ -412,7 +412,7 @@ <h2>
412412
<li class="public ">
413413
<span class="summary_signature">
414414

415-
<a href="#get_and_set-instance_method" title="#get_and_set (instance method)">#<strong>get_and_set</strong>(key, value) &#x21d2; Object<sup>?</sup> </a>
415+
<a href="#get_and_set-instance_method" title="#get_and_set (instance method)">#<strong>get_and_set</strong>(key, value) &#x21d2; Object, nil </a>
416416

417417

418418

@@ -460,7 +460,7 @@ <h2>
460460
<li class="public ">
461461
<span class="summary_signature">
462462

463-
<a href="#key-instance_method" title="#key (instance method)">#<strong>key</strong>(value) &#x21d2; Object<sup>?</sup> </a>
463+
<a href="#key-instance_method" title="#key (instance method)">#<strong>key</strong>(value) &#x21d2; Object, nil </a>
464464

465465

466466

@@ -508,7 +508,7 @@ <h2>
508508
<li class="public ">
509509
<span class="summary_signature">
510510

511-
<a href="#merge_pair-instance_method" title="#merge_pair (instance method)">#<strong>merge_pair</strong>(key, value) {|old_value| ... } &#x21d2; Object<sup>?</sup> </a>
511+
<a href="#merge_pair-instance_method" title="#merge_pair (instance method)">#<strong>merge_pair</strong>(key, value) {|old_value| ... } &#x21d2; Object, nil </a>
512512

513513

514514

@@ -531,7 +531,7 @@ <h2>
531531
<li class="public ">
532532
<span class="summary_signature">
533533

534-
<a href="#put_if_absent-instance_method" title="#put_if_absent (instance method)">#<strong>put_if_absent</strong>(key, value) &#x21d2; Object<sup>?</sup> </a>
534+
<a href="#put_if_absent-instance_method" title="#put_if_absent (instance method)">#<strong>put_if_absent</strong>(key, value) &#x21d2; Object, nil </a>
535535

536536

537537

@@ -554,7 +554,7 @@ <h2>
554554
<li class="public ">
555555
<span class="summary_signature">
556556

557-
<a href="#replace_if_exists-instance_method" title="#replace_if_exists (instance method)">#<strong>replace_if_exists</strong>(key, new_value) &#x21d2; Object<sup>?</sup> </a>
557+
<a href="#replace_if_exists-instance_method" title="#replace_if_exists (instance method)">#<strong>replace_if_exists</strong>(key, new_value) &#x21d2; Object, nil </a>
558558

559559

560560

@@ -832,7 +832,7 @@ <h3 class="signature first" id="[]-instance_method">
832832
<div class="method_details ">
833833
<h3 class="signature " id="compute-instance_method">
834834

835-
#<strong>compute</strong>(key) {|old_value| ... } &#x21d2; <tt>Object</tt><sup>?</sup>
835+
#<strong>compute</strong>(key) {|old_value| ... } &#x21d2; <tt>Object</tt>, <tt>nil</tt>
836836

837837

838838

@@ -1073,7 +1073,7 @@ <h3 class="signature " id="compute_if_absent-instance_method">
10731073
<div class="method_details ">
10741074
<h3 class="signature " id="compute_if_present-instance_method">
10751075

1076-
#<strong>compute_if_present</strong>(key) {|old_value| ... } &#x21d2; <tt>Object</tt><sup>?</sup>
1076+
#<strong>compute_if_present</strong>(key) {|old_value| ... } &#x21d2; <tt>Object</tt>, <tt>nil</tt>
10771077

10781078

10791079

@@ -1199,7 +1199,7 @@ <h3 class="signature " id="compute_if_present-instance_method">
11991199
<div class="method_details ">
12001200
<h3 class="signature " id="delete-instance_method">
12011201

1202-
#<strong>delete</strong>(key) &#x21d2; <tt>Object</tt><sup>?</sup>
1202+
#<strong>delete</strong>(key) &#x21d2; <tt>Object</tt>, <tt>nil</tt>
12031203

12041204

12051205

@@ -2034,7 +2034,7 @@ <h3 class="signature " id="fetch_or_store-instance_method">
20342034
<div class="method_details ">
20352035
<h3 class="signature " id="get_and_set-instance_method">
20362036

2037-
#<strong>get_and_set</strong>(key, value) &#x21d2; <tt>Object</tt><sup>?</sup>
2037+
#<strong>get_and_set</strong>(key, value) &#x21d2; <tt>Object</tt>, <tt>nil</tt>
20382038

20392039

20402040

@@ -2114,7 +2114,7 @@ <h3 class="signature " id="get_and_set-instance_method">
21142114
<div class="method_details ">
21152115
<h3 class="signature " id="key-instance_method">
21162116

2117-
#<strong>key</strong>(value) &#x21d2; <tt>Object</tt><sup>?</sup>
2117+
#<strong>key</strong>(value) &#x21d2; <tt>Object</tt>, <tt>nil</tt>
21182118

21192119

21202120

@@ -2253,7 +2253,7 @@ <h3 class="signature " id="keys-instance_method">
22532253
<div class="method_details ">
22542254
<h3 class="signature " id="merge_pair-instance_method">
22552255

2256-
#<strong>merge_pair</strong>(key, value) {|old_value| ... } &#x21d2; <tt>Object</tt><sup>?</sup>
2256+
#<strong>merge_pair</strong>(key, value) {|old_value| ... } &#x21d2; <tt>Object</tt>, <tt>nil</tt>
22572257

22582258

22592259

@@ -2395,7 +2395,7 @@ <h3 class="signature " id="merge_pair-instance_method">
23952395
<div class="method_details ">
23962396
<h3 class="signature " id="put_if_absent-instance_method">
23972397

2398-
#<strong>put_if_absent</strong>(key, value) &#x21d2; <tt>Object</tt><sup>?</sup>
2398+
#<strong>put_if_absent</strong>(key, value) &#x21d2; <tt>Object</tt>, <tt>nil</tt>
23992399

24002400

24012401

@@ -2488,7 +2488,7 @@ <h3 class="signature " id="put_if_absent-instance_method">
24882488
<div class="method_details ">
24892489
<h3 class="signature " id="replace_if_exists-instance_method">
24902490

2491-
#<strong>replace_if_exists</strong>(key, new_value) &#x21d2; <tt>Object</tt><sup>?</sup>
2491+
#<strong>replace_if_exists</strong>(key, new_value) &#x21d2; <tt>Object</tt>, <tt>nil</tt>
24922492

24932493

24942494

0 commit comments

Comments
 (0)