Tweak WorkflowAction kdoc

rjrjr · web-flow · commit f1df4da12d45 · 2024-01-18T14:42:44.000-08:00
diff --git a/workflow-core/src/commonMain/kotlin/com/squareup/workflow1/WorkflowAction.kt b/workflow-core/src/commonMain/kotlin/com/squareup/workflow1/WorkflowAction.kt
@@ -13,7 +13,9 @@ import kotlin.jvm.JvmOverloads
  *
  * A [WorkflowAction]'s [apply] method is executed in the context of an [Updater][WorkflowAction.Updater],
  * which provides access to the current [props][WorkflowAction.Updater.props] and
- * [state][WorkflowAction.Updater.props]. The latter can be updated with a new [StateT] instance
+ * [state][WorkflowAction.Updater.state],
+ * along with a [setOutput][WorkflowAction.Updater.setOutput] function.
+ * The [state][WorkflowAction.Updater.state] can be updated with a new [StateT] instance
  * that will become the current one after the [apply] function finishes.
  *
  * It is possible for one [WorkflowAction] to delegate to another, although the API is a bit opaque:

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,9 @@ import kotlin.jvm.JvmOverloads`
`13`	`13`	`*`
`14`	`14`	`* A [WorkflowAction]'s [apply] method is executed in the context of an [Updater][WorkflowAction.Updater],`
`15`	`15`	`* which provides access to the current [props][WorkflowAction.Updater.props] and`
`16`		`- * [state][WorkflowAction.Updater.props]. The latter can be updated with a new [StateT] instance`
	`16`	`+ * [state][WorkflowAction.Updater.state],`
	`17`	`+ * along with a [setOutput][WorkflowAction.Updater.setOutput] function.`
	`18`	`+ * The [state][WorkflowAction.Updater.state] can be updated with a new [StateT] instance`
`17`	`19`	`* that will become the current one after the [apply] function finishes.`
`18`	`20`	`*`
`19`	`21`	`* It is possible for one [WorkflowAction] to delegate to another, although the API is a bit opaque:`