Improve wording in the deprecation message

dkhalanskyjb · web-flow · commit 65f20ad6d2c0 · 2024-07-11T14:29:00.000+02:00
diff --git a/kotlinx-coroutines-core/jvm/src/Future.kt b/kotlinx-coroutines-core/jvm/src/Future.kt
@@ -13,7 +13,7 @@ import java.util.concurrent.*
  * ```
  */
 @Deprecated(
-    "This function does not do what its name implies: it will not cancel the future if just cancel() was called.",
+    "This function does not do what its name implies: it will not cancel the future if the continuation was cancelled without a cause specified (e.g., via `cancel()` with no argument).",
     level = DeprecationLevel.WARNING,
     replaceWith = ReplaceWith("this.invokeOnCancellation { future.cancel(false) }")
 )

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ import java.util.concurrent.*`
`13`	`13`	* ```
`14`	`14`	`*/`
`15`	`15`	`@Deprecated(`
`16`		`- "This function does not do what its name implies: it will not cancel the future if just cancel() was called.",`
	`16`	+ "This function does not do what its name implies: it will not cancel the future if the continuation was cancelled without a cause specified (e.g., via `cancel()` with no argument).",
`17`	`17`	`level = DeprecationLevel.WARNING,`
`18`	`18`	`replaceWith = ReplaceWith("this.invokeOnCancellation { future.cancel(false) }")`
`19`	`19`	`)`