Update outdated comment in CoroutineDispatcher.kt (#4452)

kaseken · web-flow · commit c64597cf71e9 · 2025-06-10T12:43:16.000+02:00
- Renamed backgroundDispatcher to dispatcher to match the variable name in the sample code.
diff --git a/kotlinx-coroutines-core/common/src/CoroutineDispatcher.kt b/kotlinx-coroutines-core/common/src/CoroutineDispatcher.kt
@@ -128,7 +128,7 @@ public abstract class CoroutineDispatcher :
      *
      * Note that this example was structured in such a way that it illustrates the parallelism guarantees.
      * In practice, it is usually better to use `Dispatchers.IO` or [Dispatchers.Default] instead of creating a
-     * `backgroundDispatcher`.
+     * `dispatcher`.
      *
      * ### `limitedParallelism(1)` pattern
      *

Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ public abstract class CoroutineDispatcher :`
`128`	`128`	`*`
`129`	`129`	`* Note that this example was structured in such a way that it illustrates the parallelism guarantees.`
`130`	`130`	* In practice, it is usually better to use `Dispatchers.IO` or [Dispatchers.Default] instead of creating a
`131`		- * `backgroundDispatcher`.
	`131`	+ * `dispatcher`.
`132`	`132`	`*`
`133`	`133`	* ### `limitedParallelism(1)` pattern
`134`	`134`	`*`