From f908c2a834c887e517aa73912b1a0c7e39242f49 Mon Sep 17 00:00:00 2001
From: Thanos Apollo <public@thanosapollo.org>
Date: Wed, 13 Dec 2023 22:34:59 +0200
Subject: Algorithm: Update docstrings & testing params

---
 .gitignore |  1 +
 gnosis.el  | 20 +++++++-------------
 2 files changed, 8 insertions(+), 13 deletions(-)
 create mode 100644 .gitignore

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..055298c
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+research
\ No newline at end of file
diff --git a/gnosis.el b/gnosis.el
index 2268728..704b228 100644
--- a/gnosis.el
+++ b/gnosis.el
@@ -215,16 +215,12 @@ TAGS are used to organize questions."
 ;;;;;;;;;;;;;;;;;;;;;;
 
 (defcustom gnosis-interval '(1 3)
-  "Gnosis algorithm interval.
-- Interval by which a new question is displayed or when it's ef is at 1.3.
-First item: First interval
-Second item: Second interval.
+  "Gnosis initial interval.
+
+Interval by which a new question is displayed or when it's ef is at 1.3.
 
-e.g if you use:
- (setq gnosis-interval '(2 4))
-Upon successfully recalling a question, it's next interval will be in
-2 days. Recalling the same question successfully in 2 days, will put
-it's interval at 4 days, afterwards it's next interval will be calculated using `gnosis-ef'."
+First item: First interval
+Second item: Second interval."
   :group 'gnosis
   :type 'list)
 
@@ -267,8 +263,6 @@ Returns a tuple: (INTERVAL N EF) where,
 - INTERVAL : The number of days until the item should next be reviewed.
 - N : Incremented by 1.
 - EF : Modified based on the recall success for the item."
-  ;; Ensure valid parameters.
-  ;; (cl-assert (> n 0))
   (cl-assert (and (>= success 0)
 		  (<= success 1)))
   ;; Calculate the next easiness factor.
@@ -276,8 +270,8 @@ Returns a tuple: (INTERVAL N EF) where,
          ;; Calculate the next interval.
          (interval
           (cond
-	   ;; If ef is 1.3, repeat question in the same day.
-	   ((= ef 1.3) 0)
+	   ;; Show item same day on the first review
+	   ((= n 0) 0)
            ;; Immediately next day if it's the first time review.
            ((<= n 1) (car gnosis-interval))
            ;; After 3 days if it's second review.
-- 
cgit v1.2.3