summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThanos Apollo <[email protected]>2024-01-16 11:44:09 +0200
committerThanos Apollo <[email protected]>2024-01-16 11:44:09 +0200
commitf0e0c3260d34ba5629897901807d722ebf82838a (patch)
tree71928bffb17e73737fcd1629aec3fdc6b8524464
parent5ba45f5285c92cbcb7dfbe4b3cafd8daed7590e7 (diff)
gnosis-algorithm-next-interval: Update docstring
-rw-r--r--gnosis-algorithm.el6
1 files changed, 3 insertions, 3 deletions
diff --git a/gnosis-algorithm.el b/gnosis-algorithm.el
index 2dcd33d..7f0a3ea 100644
--- a/gnosis-algorithm.el
+++ b/gnosis-algorithm.el
@@ -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)