Skip to content

Commit

Permalink
fix: Expose struct out to generate API docs (#102)
Browse files Browse the repository at this point in the history
Signed-off-by: Xuanwo <github@xuanwo.io>

---------

Signed-off-by: Xuanwo <github@xuanwo.io>
  • Loading branch information
Xuanwo authored Aug 23, 2024
1 parent d292fae commit d430103
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 3 deletions.
2 changes: 1 addition & 1 deletion src/blocking_retry.rs
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ where
}
}

/// Retry struct generated by [`Retryable`].
/// Retry struct generated by [`BlockingRetryable`].
pub struct BlockingRetry<
B: Backoff,
T,
Expand Down
2 changes: 1 addition & 1 deletion src/blocking_retry_with_context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ where
}
}

/// Retry struct generated by [`Retryable`].
/// Retry struct generated by [`BlockingRetryableWithContext`].
pub struct BlockingRetryWithContext<
B: Backoff,
T,
Expand Down
3 changes: 3 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ pub use retry::Retry;
pub use retry::Retryable;

mod retry_with_context;
pub use retry_with_context::RetryWithContext;
pub use retry_with_context::RetryableWithContext;

mod sleep;
Expand All @@ -199,4 +200,6 @@ pub use blocking_retry::BlockingRetryable;
#[cfg(not(target_arch = "wasm32"))]
mod blocking_retry_with_context;
#[cfg(not(target_arch = "wasm32"))]
pub use blocking_retry_with_context::BlockingRetryWithContext;
#[cfg(not(target_arch = "wasm32"))]
pub use blocking_retry_with_context::BlockingRetryableWithContext;
2 changes: 1 addition & 1 deletion src/retry_with_context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ where
}
}

/// Retry struct generated by [`Retryable`].
/// Retry struct generated by [`RetryableWithContext`].
pub struct RetryWithContext<
B: Backoff,
T,
Expand Down

0 comments on commit d430103

Please sign in to comment.