diff options
| author | Thanos Apollo <[email protected]> | 2024-01-16 12:54:27 +0200 |
|---|---|---|
| committer | Thanos Apollo <[email protected]> | 2024-01-16 12:54:27 +0200 |
| commit | 6b036ca26e43069fd38585b29d9225aa6cf0593b (patch) | |
| tree | 5fa5a5393ad0d5c2da0fb445a10a47fb0f85ddb5 /gnosis-algorithm.el | |
| parent | 5ba45f5285c92cbcb7dfbe4b3cafd8daed7590e7 (diff) | |
| parent | 1a4202a6c76f024d3e7bd38ee840665e5602ee0f (diff) | |
Merge branch 'version-0.1.2' into master0.1.2
- Minor updates on commentary & docstrings, using checkdoc
With this version gnosis should meet the requirments to be included on
MELPA
Diffstat (limited to 'gnosis-algorithm.el')
| -rw-r--r-- | gnosis-algorithm.el | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/gnosis-algorithm.el b/gnosis-algorithm.el index 2dcd33d..e6a2b1f 100644 --- a/gnosis-algorithm.el +++ b/gnosis-algorithm.el @@ -37,7 +37,7 @@ First item: First interval, Second item: Second interval. -Note: gnosis-algorithm-interval is ignored after 10 TOTAL reviews or +Note: `gnosis-algorithm-interval' is ignored after 10 TOTAL reviews or when ef is above > 3.0, which should only be the case for customized notes/review sessions." :group 'gnosis @@ -48,10 +48,9 @@ notes/review sessions." First item : Increase factor Second item: Decrease factor -Third item : Starting ef +Third item : Starting total ef -WARNING! Starting ef should not be above 2.5, it's recommended to keep -it below 2.0" +Note: Starting total ef should not be above 3.0" :group 'gnosis :type 'list) @@ -101,6 +100,7 @@ The structure of the given date is (YEAR MONTH DAY)." ;; This should be further tested for notes with last-interval of 0 when success 0 ;; For future versions of this algorithm, we should also calculate ;; failures in row to have "leech" like notes as well. +;; TODO: Use initial-interval value instead gnosis-algorithm-interval (defun gnosis-algorithm-next-interval (last-interval n ef success ff successful-reviews) "Calculate next interval. - LAST-INTERVAL : The number of days since the item was last reviewed. @@ -109,10 +109,10 @@ The structure of the given date is (YEAR MONTH DAY)." - SUCCESS : Success of the recall, ranges from 0 (unsuccessful) to 1 (successful). - FF: Failure factor -- SUCCESSFUL-REVIEWS : Number of successful reviews in a row. +- SUCCESSFUL-REVIEWS : Number of successful reviews. -Returns a tuple: (INTERVAL N EF) where, -- Next review date in (year month day) format. +Returns a list of: (INTERVAL N EF) where, +- Next review date in (yyyy mm dd) format. - N : Incremented by 1. - EF : Modified based on the recall success for the item." (cl-assert (and (>= success 0) |