Documentation fixes

Author: qwwdfsad

README.md

@@ -31,7 +31,7 @@ GlobalScope.launch {
 * [core](core/README.md) — Kotlin/JVM implementation of common coroutines with additional features:
   * `Dispatchers.IO` dispatcher for blocking coroutines;
   * `Executor.asCoroutineDispatcher()` extension, custom thread pools, and more.
-* [core-test](core/README.md) — test utilities for coroutines, currently with one feature:
+* [test](core/README.md) — test utilities for coroutines, currently with one feature:
   * `MainDispatcherInjector.inject()` to override `Dispatchers.Main` in tests.
 * [js](js/README.md) — Kotlin/JS implementation of common coroutines with `Promise` support.
 * [native](native/README.md) — Kotlin/Native implementation of common coroutines with `runBlocking` single-threaded event loop.

RELEASE.md

@@ -12,7 +12,7 @@ To release new `<version>` of `kotlinx-coroutines`:
    `git merge origin/master`   
 
 4. Search & replace `<old-version>` with `<version>` across the project files. Should replace in:
-   * [`README.md`](README.md) (native, core, core-test modules)
+   * [`README.md`](README.md) (native, core, test modules)
    * [`coroutines-guide.md`](docs/coroutines-guide.md)
    * [`gradle.properties`](gradle.properties)
    * [`ui/kotlinx-coroutines-android/example-app/gradle.properties`](ui/kotlinx-coroutines-android/example-app/gradle.properties)    

common/kotlinx-coroutines-core-common/src/internal/MainDispatcherFactory.kt

@@ -12,13 +12,13 @@ public interface MainDispatcherFactory {
     val loadPriority: Int // higher priority wins
 
     /**
-     * Creates main dispatcher. [allFactories] parameter contains all factories found by service loader.
+     * Creates the main dispatcher. [allFactories] parameter contains all factories found by service loader.
      * This method is not guaranteed to be idempotent.
      */
     fun createDispatcher(allFactories: List<MainDispatcherFactory>): MainCoroutineDispatcher
 
     /**
-     * Hint used along with error message when factory failed to create a dispatcher.
+     * Hint used along with error message when the factory failed to create a dispatcher.
      */
     fun hintOnError(): String? = null
 }

core/README.md

@@ -6,5 +6,5 @@ Module name below corresponds to the artifact name in Maven/Gradle.
 ## Modules
 
 * [kotlinx-coroutines-core](kotlinx-coroutines-core/README.md) — core coroutine builders and synchronization primitives. 
-* [kotlinx-coroutines-core-test](kotlinx-coroutines-core-test/README.md) — coroutines test utilities such as Main dispatcher injection.
+* [kotlinx-coroutines-test](kotlinx-coroutines-test/README.md) — coroutines test utilities such as Main dispatcher injection.
 

core/kotlinx-coroutines-test/README.md

@@ -1,6 +1,6 @@
 # Module kotlinx-coroutines-test
 
-Test utilities for `kotlinx.coroutines`. Provides `Dispatchers.setMain` to override `Main` dispatcher.
+Test utilities for `kotlinx.coroutines`. Provides `Dispatchers.setMain` to override the `Main` dispatcher.
 
 ## Using in your project
 
@@ -13,10 +13,10 @@ dependencies {
 
 **Do not** depend on this project in your main sources, all utilities are intended and designed to be used only from tests. 
 
-Once you have it in runtime, [`ServiceLoader`](https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html) mechanism will
-overwrite [Dispatchers.Main] with testable implementation.
+Once you have this dependency in the runtime, [`ServiceLoader`](https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html) mechanism will
+overwrite [Dispatchers.Main] with a testable implementation.
 
-You can override this implementation using [setMain][Dispatchers.setMain] method with any [CoroutineDispatcher] implementation, e.g.:
+You can override the `Main` implementation using [setMain][setMain] method with any [CoroutineDispatcher] implementation, e.g.:
 
 ```kotlin
 
@@ -31,13 +31,13 @@ class SomeTest {
 
     @After
     fun tearDown() {
-        Dispatchers.resetMain() // reset main dispatcher to original Main dispatcher
+        Dispatchers.resetMain() // reset main dispatcher to the original Main dispatcher
         mainThreadSurrogate.close()
     }
 
     @Test
     fun testSomeUI() = runBlocking {
-        launch(Dispatchers.Main) {  // Will be launched in mainThreadSurrogate dispatcher
+        launch(Dispatchers.Main) {  // Will be launched in the mainThreadSurrogate dispatcher
             ...
         }
     }
@@ -48,4 +48,7 @@ class SomeTest {
 <!--- INDEX kotlinx.coroutines -->
 [Dispatchers.Main]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/-dispatchers/-main.html
 [CoroutineDispatcher]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-dispatcher/index.html
+<!--- MODULE kotlinx-coroutines-test -->
+<!--- INDEX kotlinx.coroutines.test -->
+[setMain]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-test/kotlinx.coroutines.test/kotlinx.coroutines.-dispatchers/set-main.html
 <!--- END -->

core/kotlinx-coroutines-test/resources/META-INF/proguard/coroutines.pro

@@ -1,5 +1,5 @@
 # ServiceLoader support
--keepnames class kotlinx.coroutines.test.internal.InjectableDispatcherFactory {}
+-keepnames class kotlinx.coroutines.test.internal.TestMainDispatcherFactory {}
 
 # Most of volatile fields are updated with AFU and should not be mangled
 -keepclassmembernames class kotlinx.** {

core/kotlinx-coroutines-test/src/TestDispatchers.kt

@@ -10,9 +10,8 @@ import kotlinx.coroutines.*
 import kotlinx.coroutines.test.internal.*
 
 /**
- * Sets given dispatcher as an underlying dispatcher of [Dispatchers.Main].
- * All consecutive usages of [Dispatchers.Main] will use given [dispatcher] under the hood, though it's not guaranteed
- * that [Dispatchers.Main] will be equal to given [dispatcher].
+ * Sets the given [dispatcher] as an underlying dispatcher of [Dispatchers.Main].
+ * All consecutive usages of [Dispatchers.Main] will use given [dispatcher] under the hood.
  *
  * It is unsafe to call this method if alive coroutines launched in [Dispatchers.Main] exist.
  */
@@ -24,9 +23,9 @@ public fun Dispatchers.setMain(dispatcher: CoroutineDispatcher = Dispatchers.Unc
 }
 
 /**
- * Resets state of [Dispatchers.Main] to the original main dispatcher.
+ * Resets state of the [Dispatchers.Main] to the original main dispatcher.
  * For example, in Android Main thread dispatcher will be set as [Dispatchers.Main].
- * Used to cleanup all possible dependencies, should be used in tear down (`@After`) methods.
+ * Used to clean up all possible dependencies, should be used in tear down (`@After`) methods.
  *
  * It is unsafe to call this method if alive coroutines launched in [Dispatchers.Main] exist.
  */

core/kotlinx-coroutines-test/src/internal/MainTestDispatcher.kt

@@ -9,7 +9,7 @@ import kotlinx.coroutines.internal.*
 import kotlin.coroutines.*
 
 /**
- * Testable main dispatcher used by kotlinx-coroutines-test.
+ * The testable main dispatcher used by kotlinx-coroutines-test.
  * It is a [MainCoroutineDispatcher] which delegates all actions to a settable delegate.
  */
 internal class TestMainDispatcher(private val mainFactory: MainDispatcherFactory) : MainCoroutineDispatcher(), Delay {
@@ -80,8 +80,8 @@ internal class TestMainDispatcherFactory : MainDispatcherFactory {
     }
 
     /**
-     * [Int.MAX_VALUE] -- test dispatcher always wins no matter what factories are present in classpath.
-     * By default all actions are delegated to the second-priority dispatcher, so it won't be the issue.
+     * [Int.MAX_VALUE] -- test dispatcher always wins no matter what factories are present in the classpath.
+     * By default all actions are delegated to the second-priority dispatcher, so that it won't be the issue.
      */
     override val loadPriority: Int
         get() = Int.MAX_VALUE

knit/resources/knit.properties

@@ -4,6 +4,6 @@
 
 site.root=https://kotlin.github.io/kotlinx.coroutines
 
-module.roots=common js core core-test integration native reactive ui
+module.roots=common js core test integration native reactive ui
 module.marker=build.gradle
-module.docs=build/dokka
+module.docs=build/dokka