diff --git a/CHANGELOG.md b/CHANGELOG.md index effe43c..42f8c60 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## 1.1.0 + +- Fix coding standard. +- Fix dart score analyzed +- Improve documentation + ## 1.0.0 - Initial version. diff --git a/lib/src/models.dart b/lib/src/models.dart index c74c5f6..929e7a8 100644 --- a/lib/src/models.dart +++ b/lib/src/models.dart @@ -45,9 +45,13 @@ class ReviewLog { } } +/// Store card data class Card { + /// The time when the card is scheduled to be reviewed again late DateTime due; double stability = 0; + + /// How challenging or easy you find a specific flashcard during a review session double difficulty = 0; int elapsedDays = 0; int scheduledDays = 0; @@ -71,12 +75,13 @@ class Card { }); } + /// Construct current time for due and last review Card() { due = DateTime.now().toUtc(); lastReview = DateTime.now().toUtc(); } - // .from Constructor for copying + /// Helper to clone from a card factory Card.copyFrom(Card card) { Card newCard = Card(); newCard.due = card.due; @@ -105,6 +110,7 @@ class Card { } } +/// Store card and review log info class SchedulingInfo { late Card card; late ReviewLog reviewLog; @@ -112,6 +118,7 @@ class SchedulingInfo { SchedulingInfo(this.card, this.reviewLog); } +/// Calculate next review class SchedulingCards { late Card again; late Card hard; diff --git a/pubspec.yaml b/pubspec.yaml index e87719c..2e0a7b8 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,7 +1,8 @@ name: fsrs -description: Dart Package for FSRS +description: A Dart package for FSRS, which implements the Free Spaced Repetition Scheduler algorithm. This package assists developers in incorporating FSRS into their flashcard applications. + version: 1.0.0 -repository: https://github.com/sonbui00/dart-fsrs +repository: https://github.com/open-spaced-repetition/dart-fsrs environment: sdk: ^3.3.0