Skip to content

Commit 87162f5

Browse files
chore: upgrade doc code to no_run (#1242)
1 parent a9481aa commit 87162f5

2 files changed

Lines changed: 16 additions & 10 deletions

File tree

crates/client/src/schedules.rs

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -761,10 +761,17 @@ where
761761
/// Describes the current schedule, applies the closure to modify it, and
762762
/// sends the update. The conflict token is managed automatically.
763763
///
764-
/// ```ignore
765-
/// handle.update(|u| {
766-
/// u.set_note("updated").set_paused(true);
767-
/// }).await?;
764+
/// ```no_run
765+
/// # async fn hidden(
766+
/// # handle: &temporalio_client::schedules::ScheduleHandle<temporalio_client::Client>,
767+
/// # ) -> Result<(), temporalio_client::schedules::ScheduleError> {
768+
/// handle
769+
/// .update(|u| {
770+
/// u.set_note("updated").set_paused(true);
771+
/// })
772+
/// .await?;
773+
/// # Ok(())
774+
/// # }
768775
/// ```
769776
// TODO: Add a retry loop for conflict token mismatch. The server
770777
// returns FailedPrecondition with "mismatched conflict token".

crates/sdk/src/workflows.rs

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@
5454
///
5555
/// # Example
5656
///
57-
/// ```ignore
57+
/// ```no_run
58+
/// use std::time::Duration;
5859
/// use temporalio_sdk::workflows::select;
5960
/// use temporalio_sdk::WorkflowContext;
60-
/// use std::time::Duration;
6161
///
6262
/// # async fn hidden(ctx: &mut WorkflowContext<()>) {
6363
/// select! {
@@ -77,7 +77,7 @@ pub use crate::__temporal_select as select;
7777
///
7878
/// # Example
7979
///
80-
/// ```ignore
80+
/// ```no_run
8181
/// use temporalio_sdk::workflows::join;
8282
///
8383
/// # async fn hidden() {
@@ -695,10 +695,9 @@ pub fn serialize_result<T: TemporalSerializable + 'static>(
695695
///
696696
/// # Example
697697
///
698-
/// ```ignore
699-
/// use temporalio_sdk::workflows::join_all;
700-
/// use temporalio_sdk::WorkflowContext;
698+
/// ```no_run
701699
/// use std::time::Duration;
700+
/// use temporalio_sdk::{WorkflowContext, workflows::join_all};
702701
///
703702
/// # async fn hidden(ctx: &mut WorkflowContext<()>) {
704703
/// let timers = vec![

0 commit comments

Comments
 (0)