Skip to content

Commit e05d3ce

Browse files
committed
Update documentation
1 parent 228a130 commit e05d3ce

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

src/function.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,9 @@ pub trait Configuration: Any {
9595
/// value from the latest iteration of this cycle. `count` is the number of cycle iterations
9696
/// completed so far.
9797
///
98+
/// The function is called for every iteration of the cycle head, regardless of whether the cycle
99+
/// has converged (the values are equal).
100+
///
98101
/// # Id
99102
///
100103
/// The id can be used to uniquely identify the query instance. This can be helpful
@@ -112,9 +115,8 @@ pub trait Configuration: Any {
112115
/// * **Initial value**: `iteration` may be non-zero on the first call for a given query if that
113116
/// query becomes the outermost cycle head after a nested cycle complete a few iterations. In this case,
114117
/// `iteration` continues from the nested cycle's iteration count rather than resetting to zero.
115-
/// * **Non-contiguous values**: This function isn't called if this cycle is part of an outer cycle
116-
/// and the value for this query remains unchanged for one iteration. But the outer cycle might
117-
/// keep iterating because other heads keep changing.
118+
/// * **Non-contiguous values**: The iteration count can be non-contigious for cycle heads
119+
/// that are only conditionally part of a cycle.
118120
fn recover_from_cycle<'db>(
119121
db: &'db Self::DbView,
120122
id: Id,

0 commit comments

Comments
 (0)