aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhillip Lord <phillip.lord@russet.org.uk>2019-07-11 08:56:52 +0100
committerPhillip Lord <phillip.lord@russet.org.uk>2019-07-11 08:56:52 +0100
commit7adb9aab5ad25fe562d86d40111dcd485a807303 (patch)
tree4f4b57d4bd43e08edb1c90f76b3f33e4c9730216
parentfecfc9c9a9a441c394ab9d8fd03f1f45483b0991 (diff)
downloadorg-drill-7adb9aab5ad25fe562d86d40111dcd485a807303.tar.gz
org-drill-7adb9aab5ad25fe562d86d40111dcd485a807303.zip
Update documentation
-rw-r--r--org-drill.el7
1 files changed, 7 insertions, 0 deletions
diff --git a/org-drill.el b/org-drill.el
index 3efc353..5f35aba 100644
--- a/org-drill.el
+++ b/org-drill.el
@@ -687,6 +687,7 @@ regardless of whether the test was successful.")
;;;; Utilities ================================================================
(defmacro org-drill-pop-random (place)
+ "Remove an item randomly from PLACE."
(let ((idx (cl-gensym)))
`(if (null ,place)
nil
@@ -713,6 +714,7 @@ CMD is bound, or nil if it is not bound to a key."
(if key (key-description key))))
(defun org-drill-time-to-inactive-org-timestamp (time)
+ "Convert TIME into org-mode timestamp."
(format-time-string
(concat "[" (substring (cdr org-time-stamp-formats) 1 -1) "]")
time))
@@ -746,6 +748,8 @@ Returns scope as defined by `org-map-entries'"
(t scope))))
(defmacro org-drill-with-hidden-cloze-text (&rest body)
+ "Eval BODY with clozed text hidden."
+ (declare (debug t))
`(progn
(org-drill-hide-clozed-text)
(unwind-protect
@@ -754,6 +758,7 @@ Returns scope as defined by `org-map-entries'"
(org-drill-unhide-clozed-text))))
(defmacro org-drill-with-hidden-cloze-hints (&rest body)
+ "Eval BODY with cloze hints hidden."
(declare (debug t))
`(progn
(org-drill-hide-cloze-hints)
@@ -763,6 +768,8 @@ Returns scope as defined by `org-map-entries'"
(org-drill-unhide-text))))
(defmacro org-drill-with-hidden-comments (&rest body)
+ "Eval BODY with comments hidden."
+ (declare (debug t))
`(progn
(if org-drill-hide-item-headings-p
(org-drill-hide-heading-at-point))