aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhillip Lord <phillip.lord@russet.org.uk>2019-07-10 22:38:01 +0100
committerPhillip Lord <phillip.lord@russet.org.uk>2019-07-10 22:38:01 +0100
commitfecfc9c9a9a441c394ab9d8fd03f1f45483b0991 (patch)
tree4e718af7fb2f98a814f78cfbfcd34cbaea5f31cf
parent9e3a7952a15a953ea0b7ee5dbdbb6df948f063ce (diff)
downloadorg-drill-fecfc9c9a9a441c394ab9d8fd03f1f45483b0991.tar.gz
org-drill-fecfc9c9a9a441c394ab9d8fd03f1f45483b0991.zip
Add documentation
-rw-r--r--org-drill.el13
1 files changed, 9 insertions, 4 deletions
diff --git a/org-drill.el b/org-drill.el
index f8421d8..3efc353 100644
--- a/org-drill.el
+++ b/org-drill.el
@@ -581,8 +581,7 @@ interval was greater than ORG-DRILL-DAYS-BEFORE-OLD days.")
(cram-mode
:initform nil
:documementation "Are we in 'cram mode', where all items are considered due
-for review unless they were already reviewed in the recent past?"
- )
+for review unless they were already reviewed in the recent past?")
(warned-about-id-creation
:initform nil
:documentation "Have we warned the user about ID creation this session?")
@@ -608,9 +607,15 @@ random number to another language.")
:documentation "An org-drill session object carries data about
the current state of a particular org-drill session." )
-(defvar org-drill-current-session nil)
+(defvar org-drill-current-session nil
+ "If non-nil, the current session.
+
+The current session is an `org-drill-session' object.")
+
+(defvar org-drill-last-session nil
+ "If non-nil, the last session.
-(defvar org-drill-last-session nil)
+This can be used to resume the last session.")
(defvar org-drill-cards-in-this-emacs 0
"The total number of cards displayed in this Emacs invocation.