Mark runningWorker with no output as @deprecated

square · May 2, 2023 · 62508de · 62508de
1 parent d9b6824
commit 62508de
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/workflow-core/src/commonMain/kotlin/com/squareup/workflow1/BaseRenderContext.kt b/workflow-core/src/commonMain/kotlin/com/squareup/workflow1/BaseRenderContext.kt
@@ -249,10 +249,14 @@ BaseRenderContext<PropsT, StateT, OutputT>.renderChild(
  * Ensures a [Worker] that never emits anything is running. Since [worker] can't emit anything,
  * it can't trigger any [WorkflowAction]s.
  *
- * If your [Worker] does not output anything, then simply use [runningSideEffect].
+ * If your [Worker] does not output anything, then simply use [BaseRenderContext.runningSideEffect].
  *
  * @param key An optional string key that is used to distinguish between identical [Worker]s.
  */
+@Deprecated(
+  message = "Use [BaseRenderContext.runningSideEffect] instead.",
+  replaceWith = ReplaceWith(expression = "runningSideEffect(key) { ... }", "")
+)
 public inline fun <reified W : Worker<Nothing>, PropsT, StateT, OutputT>
 BaseRenderContext<PropsT, StateT, OutputT>.runningWorker(
   worker: W,