Update documentation for is_reset method in RevlogEntry to clarify ease_factor condition

This commit is contained in:
Jarrett Ye 2025-08-04 15:21:00 +08:00
parent 6947afddb6
commit 0a60d795dc
No known key found for this signature in database
GPG key ID: EBFC55E0C1A352BB

View file

@ -88,6 +88,9 @@ impl RevlogEntry {
/// Returns true if this entry represents a reset operation.
/// These entries are created when a card is reset using
/// [`Collection::reschedule_cards_as_new`].
/// The `ease_factor` should be 0 because
/// [`Collection::set_due_date`] also sets created `RevlogEntry` with
/// `RevlogReviewKind::Manual` but the `ease_factor` is not 0.
pub(crate) fn is_reset(&self) -> bool {
self.review_kind == RevlogReviewKind::Manual && self.ease_factor == 0
}