mirror of
https://github.com/ankitects/anki.git
synced 2025-09-18 22:12:21 -04:00
Update documentation for is_reset method in RevlogEntry to clarify ease_factor condition
This commit is contained in:
parent
6947afddb6
commit
0a60d795dc
1 changed files with 3 additions and 0 deletions
|
@ -88,6 +88,9 @@ impl RevlogEntry {
|
||||||
/// Returns true if this entry represents a reset operation.
|
/// Returns true if this entry represents a reset operation.
|
||||||
/// These entries are created when a card is reset using
|
/// These entries are created when a card is reset using
|
||||||
/// [`Collection::reschedule_cards_as_new`].
|
/// [`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 {
|
pub(crate) fn is_reset(&self) -> bool {
|
||||||
self.review_kind == RevlogReviewKind::Manual && self.ease_factor == 0
|
self.review_kind == RevlogReviewKind::Manual && self.ease_factor == 0
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue