Skip to content

Commit

Permalink
Document that summary's order should be compatible
Browse files Browse the repository at this point in the history
At time of writing, I'm not sure about the exact relationship here, but
there definitely ought to be one!
  • Loading branch information
bkirwi committed Mar 17, 2023
1 parent 043ef73 commit c18d40d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 1 addition & 1 deletion timely/src/progress/reachability.rs
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ impl<T: Timestamp> Builder<T> {
Tracker::allocate_from(self, logger)
}

/// Tests whether the graph a cycle of default path summaries.
/// Tests whether the graph includes a cycle of default path summaries.
///
/// Graphs containing cycles of default path summaries will most likely
/// not work well with progress tracking, as a timestamp can result in
Expand Down
4 changes: 4 additions & 0 deletions timely/src/progress/timestamp.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ pub trait PathSummary<T> : Clone+'static+Eq+PartialOrder+Debug+Default {
/// in computation, uses this method and will drop messages with timestamps that when advanced
/// result in `None`. Ideally, all other timestamp manipulation should behave similarly.
///
/// This summary's partial order is expected to be compatible with the partial order of [T],
/// in the sense that if `s1.less_equal(s2)`, then `s1.results_in(&t)` is less than or equal to
/// `s2.results_in(&t)`.
///
/// Note that `Self::default()` is expected to behave as an "empty" or "noop" summary, such that
/// `Self::default().results_in(&t) == Some(t)`.
///
Expand Down

0 comments on commit c18d40d

Please sign in to comment.