From e5af281a91b81d018550cc6fa6c89b167ded6613 Mon Sep 17 00:00:00 2001
From: Elijah Verdoorn <elijah.verdoorn@wework.com>
Date: Sun, 27 Oct 2019 09:04:13 -0700
Subject: [PATCH] Add additional explanation commentary.

---
 src/main/kotlin/cancel/KtCancel.kt           |  6 +++---
 src/main/kotlin/cancel/RxCancel.kt           | 14 +++++++-------
 src/main/kotlin/completable/KtCompletable.kt |  2 +-
 src/main/kotlin/filter/KtFilter.kt           |  4 ++--
 src/main/kotlin/merge/KtMerge.kt             |  2 +-
 5 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/src/main/kotlin/cancel/KtCancel.kt b/src/main/kotlin/cancel/KtCancel.kt
index aa870cf..7e3474a 100644
--- a/src/main/kotlin/cancel/KtCancel.kt
+++ b/src/main/kotlin/cancel/KtCancel.kt
@@ -29,13 +29,13 @@ class KtCancel (
         val job = launch { longRunningFunction() }
 
         launch {
-            delay(5000) // wait 5 seconds
-            job.cancel()
+            delay(5000) // wait 5 seconds,
+            job.cancel() // then cancel the running coroutine
         }
     }
 
     suspend fun longRunningFunction() {
-        while (isActive) {
+        while (isActive) { // check that the coroutine has not been canceled
             println("Long running job still active in KtCancel")
             delay(timeDelay)
         }
diff --git a/src/main/kotlin/cancel/RxCancel.kt b/src/main/kotlin/cancel/RxCancel.kt
index 9cae1db..a8ebf00 100644
--- a/src/main/kotlin/cancel/RxCancel.kt
+++ b/src/main/kotlin/cancel/RxCancel.kt
@@ -25,22 +25,22 @@ private const val timeDelay = 1000L
 class RxCancel (
     scheduler: Scheduler = Schedulers.computation()
 ) {
-    val stream = Flowable.interval(timeDelay, TimeUnit.MILLISECONDS)
+    val stream = Flowable.interval(timeDelay, TimeUnit.MILLISECONDS) // Once every second...
         .observeOn(scheduler)
         .map {
-            "Long running job still active in RxCancel"
+            "Long running job still active in RxCancel" // emit this string
         }
 
     init {
         val disposable = stream.subscribe({
-            println(it)
+            println(it) // log every emission to the console
         })
 
         Completable.fromAction {
-            disposable.dispose()
+            disposable.dispose() // throw away our subscription to the stream, canceling it
         }
-            .observeOn(scheduler)
-            .delaySubscription(5000, TimeUnit.MILLISECONDS)
-            .subscribe()
+        .observeOn(scheduler)
+        .delaySubscription(5000, TimeUnit.MILLISECONDS) // Wait 5 seconds, then subscribe (for demonstration purposes)
+        .subscribe()
     }
 }
\ No newline at end of file
diff --git a/src/main/kotlin/completable/KtCompletable.kt b/src/main/kotlin/completable/KtCompletable.kt
index cebcd8c..ae1c7ad 100644
--- a/src/main/kotlin/completable/KtCompletable.kt
+++ b/src/main/kotlin/completable/KtCompletable.kt
@@ -26,7 +26,7 @@ class KtCompletable(
 ): CoroutineScope {
 
     init {
-        launch {
+        launch { // Since the encapsulating class extends CoroutineScope, we can simply use the launch coroutine builder to fire the work as a child of the current scope
             doSomeWork()
         }
     }
diff --git a/src/main/kotlin/filter/KtFilter.kt b/src/main/kotlin/filter/KtFilter.kt
index faf74c1..b08465e 100644
--- a/src/main/kotlin/filter/KtFilter.kt
+++ b/src/main/kotlin/filter/KtFilter.kt
@@ -34,8 +34,8 @@ class KtFilter (
 
     init {
         launch {
-            producer.filter { it % 2 == 0 }
-            .consumeEach {
+            producer.filter { it % 2 == 0 } // the .filter operator here will only send even numbers downstream
+            .consumeEach { // consumeEach subscribes to the producer Channel
                 println("Value from KtFilter: $it")
             }
         }
diff --git a/src/main/kotlin/merge/KtMerge.kt b/src/main/kotlin/merge/KtMerge.kt
index 2c312ae..7bb0e1a 100644
--- a/src/main/kotlin/merge/KtMerge.kt
+++ b/src/main/kotlin/merge/KtMerge.kt
@@ -29,7 +29,7 @@ class KtMerge(
 
     init {
         launch {
-            flowOf(flowOne, flowTwo).flattenMerge().collect {
+            flowOf(flowOne, flowTwo).flattenMerge().collect { // without the flattenMerge() we'd have a flow of flows rather than a flow of Ints
                 println("Value from KtMerge $it")
             }
         }