Skip to content

Commit 5fe5c45

Browse files
committed
Improve workflow docs
1 parent e4ee7e0 commit 5fe5c45

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/lib.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -353,17 +353,17 @@ pub use restate_sdk_macros::object;
353353
///
354354
/// A workflow can be seen as a special type of [Virtual Object](https://docs.restate.dev/concepts/services#virtual-objects) with the following characteristics:
355355
///
356-
/// - Each workflow definition has a **`Run` handler** that implements the workflow logic.
357-
/// - The `Run` handler **executes exactly one time** for each workflow instance (object / key).
358-
/// - The `Run` handler executes a set of **durable steps/activities**. These can either be:
356+
/// - Each workflow definition has a **`run` handler** that implements the workflow logic.
357+
/// - The `run` handler **executes exactly one time** for each workflow instance (object / key).
358+
/// - The `run` handler executes a set of **durable steps/activities**. These can either be:
359359
/// - Inline activities: for example a [run block](crate::context::ContextSideEffects) or [sleep](crate::context::ContextTimers)
360360
/// - [Calls to other handlers](crate::context::ContextClient) implementing the activities
361361
/// - You can **submit a workflow** in the same way as any handler invocation (via SDK clients or Restate services, over HTTP or Kafka).
362362
/// - A workflow definition can implement other handlers that can be called multiple times, and can **interact with the workflow**:
363363
/// - Query the workflow (get information out of it) by getting K/V state or awaiting promises that are resolved by the workflow.
364364
/// - Signal the workflow (send information to it) by resolving promises that the workflow waits on.
365365
/// - Workflows have access to the [`WorkflowContext`](crate::context::WorkflowContext) and [`SharedWorkflowContext`](crate::context::SharedWorkflowContext), giving them some extra functionality, for example [Durable Promises](#signaling-workflows) to signal workflows.
366-
/// - The K/V state of the workflow is isolated to the workflow execution, and can only be mutated by the `Run` handler.
366+
/// - The K/V state of the workflow is isolated to the workflow execution, and can only be mutated by the `run` handler.
367367
///
368368
/// **Note: Workflow retention time**:
369369
/// The retention time of a workflow execution is 24 hours after the finishing of the `run` handler.

0 commit comments

Comments
 (0)