alankan886 / supermemo2 Goto Github PK

After speaking with @blazej-czapp and receiving useful feedback, I'm looking to push out a new version that's simpler and more user-friendly.

To toss off the over-engineered code, my main goals are:

1. Keeping the class attributes simple (i.e. no previous and current values)
2. Adding review(quality, review_date) function and keeping first_review(quality, review_date), removing everything else.
3. Allowing the user to input date as a string with format Year-Month-Day and other common formats.

The flow of using the package when pulling data from the database would be:

from supermemo2 import SMTwo
# first review
review = SMTwo.first_review(quality, review_date)

# after first review
# your read data from db for your existing values
# new review
# returns an SMTwo object with the new values
review = SMTwo(easiness, interval, repetitions).review(quality, review_date)

User Story

As a developer, I want stronger tests for first_review and modify in test_api.py, so that I can rely more on the tests.

Description

Tests for first_review and modify aren't checking current values.

Especially with the modify method, the current values update correspond to changes in the previous values. I think it's important to check if the current values have been updated correctly.

Acceptance Criteria

• All tests under test_api.py besides test_modify_no_inputs checks current values.

Steps

1. Find the expected values in test_sm_two.py or calculate them.
2. Add expected values into test cases for each test.
3. Add asserts checking the current value against the expected values.

Is it possible that the next review_date is today? Like Anki does when the answer is "Again" (I don't know what it means in the SM2 terms)

I had some misunderstanding of the explanation of the algorithm, EF factor should always be calculated for every quality value.

I thought If the quality response was lower than 3 then start repetitions for the item from the beginning without changing the E-Factor means not to calculate a new EF factor, but it really means reset the repetitions and keep the new E-Factor.