Skip to content

Commit d99ba5c

Browse files
committed
Adjust documentation
1 parent 2a5fbcb commit d99ba5c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

lychee-lib/src/chain/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
//!
66
//! The chain is implemented as a vector of [`Chainable`] handlers. It is
77
//! traversed by calling [`Chain::traverse`], which will call
8-
//! [`Chainable::chain`] on each handler in the chain.
8+
//! [`Chainable::chain`] on each handler in the chain consecutively.
99
//!
1010
//! To add external handlers, you can implement the [`Chainable`] trait and add
1111
//! the handler to the chain.
@@ -25,7 +25,7 @@ use tokio::sync::Mutex;
2525
/// - If the chain should continue, the handler should return
2626
/// [`ChainResult::Next`]. This will traverse the next handler in the chain.
2727
/// - If the chain should stop, the handler should return [`ChainResult::Done`].
28-
/// This will stop the chain immediately and return the result of the handler.
28+
/// All subsequent chain elements are skipped and the result is returned.
2929
#[derive(Debug, PartialEq)]
3030
pub enum ChainResult<T, R> {
3131
/// Continue to the next handler in the chain.

0 commit comments

Comments
 (0)