Skip to content

Commit d2c3afa

Browse files
committed
docs: address warning in docs
Was referencing a private type in docs
1 parent 066e1fe commit d2c3afa

2 files changed

Lines changed: 4 additions & 1 deletion

File tree

src/data_state.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ pub enum DataStateError<E: ErrorBounds> {
3030
/// Provides a way to ensure the calling code knows if it is calling a function
3131
/// that cannot do anything useful anymore
3232
pub enum CanMakeProgress {
33+
/// Used to indicate that it is still possible for progress to be made
3334
AbleToMakeProgress,
35+
36+
/// Used to indicate that further calls are not useful as no progress can be made in current state
3437
UnableToMakeProgress,
3538
}
3639

src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ mod traits;
7979
#[cfg(feature = "yield_now")]
8080
mod yield_;
8181

82-
pub use data_state::{Awaiting, DataState, DataStateError, ErrorBounds};
82+
pub use data_state::{Awaiting, CanMakeProgress, DataState, DataStateError, ErrorBounds};
8383
pub use data_state_retry::DataStateRetry;
8484
pub use platform::{fetch, fetch_plus, spawn};
8585
pub use traits::{BoundedFuture, DoneHandler, ResponseHandler, UiCallBack, ValidReturn};

0 commit comments

Comments
 (0)