[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/org-drill 546336d207 225/251: Update documentation.
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/org-drill 546336d207 225/251: Update documentation. |
Date: |
Mon, 17 Jan 2022 18:59:21 -0500 (EST) |
branch: elpa/org-drill
commit 546336d207306b53940892e871e341fb7762e2c7
Author: Phillip Lord <phillip.lord@russet.org.uk>
Commit: Phillip Lord <phillip.lord@russet.org.uk>
Update documentation.
---
org-drill.el | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/org-drill.el b/org-drill.el
index 667a1d8f20..3ddee7bfb8 100644
--- a/org-drill.el
+++ b/org-drill.el
@@ -1847,13 +1847,14 @@ visual overlay, or with the string TEXT if it is
supplied."
(org-drill-hide-region (match-beginning 0) (match-end 0)))))
(defun org-drill-unhide-text ()
- ;; This will also unhide the item's heading.
+ "Unhide text."
(save-excursion
(dolist (ovl (overlays-in (point-min) (point-max)))
(when (eql 'org-drill-hidden-text-overlay (overlay-get ovl 'category))
(delete-overlay ovl)))))
(defun org-drill-hide-clozed-text ()
+ "Hide clozed text."
(save-excursion
(while (re-search-forward org-drill-cloze-regexp nil t)
;; Don't hide:
@@ -1901,6 +1902,7 @@ visual overlay, or with the string TEXT if it is
supplied."
"")))))))
(defun org-drill-hide-cloze-hints ()
+ "Hide cloze hints."
(save-excursion
(while (re-search-forward org-drill-cloze-regexp nil t)
(unless (or (save-match-data
@@ -1953,6 +1955,7 @@ Note: does not actually alter the item."
(overlay-put ovl 'display text)))))
(defun org-drill-unreplace-entry-text ()
+ "Unreplace entry text."
(save-excursion
(dolist (ovl (overlays-in (point-min) (point-max)))
(when (eql 'org-drill-replaced-text-overlay (overlay-get ovl 'category))
@@ -1980,6 +1983,7 @@ Note: does not actually alter the item."
(overlay-put ovl 'display (nth i replacements)))))
(defmacro org-drill-with-replaced-entry-heading (heading &rest body)
+ "Display HEADING in place of current entry heading, and execute BODY."
`(progn
(org-drill-replace-entry-heading ,heading)
(unwind-protect
@@ -1994,12 +1998,14 @@ Note: does not actually alter the item."
(org-drill-hide-heading-at-point heading))
(defun org-drill-unhide-clozed-text ()
+ "Show clozed text."
(save-excursion
(dolist (ovl (overlays-in (point-min) (point-max)))
(when (eql 'org-drill-cloze-overlay-defaults (overlay-get ovl 'category))
(delete-overlay ovl)))))
(defun org-drill-get-entry-text (&optional keep-properties-p)
+ "Return the text of the current entry."
(let ((text (org-agenda-get-some-entry-text (point-marker) 100)))
(if keep-properties-p
text
@@ -2010,6 +2016,7 @@ Note: does not actually alter the item."
;; This version is about 5x faster than the old version, above.
(defun org-drill-entry-empty-p ()
+ "Return non-nil if the current entry is empty."
(save-excursion
(org-back-to-heading t)
(let ((lim (save-excursion
@@ -2029,6 +2036,7 @@ Note: does not actually alter the item."
;; topic, and should return t if the user chose to see the answer and rate
their
;; recall, nil if they chose to quit.
(defun org-drill-present-simple-card (session)
+ "Present a simple card."
(org-drill-with-hidden-comments
(org-drill-with-hidden-cloze-hints
(org-drill-with-hidden-cloze-text
@@ -2041,6 +2049,10 @@ Note: does not actually alter the item."
(org-drill-hide-subheadings-if 'org-drill-entry-p))))))
(defun org-drill-present-default-answer (session reschedule-fn)
+ "Present a default answer.
+
+SESSION is the current session.
+RESCHEDULE-FN is the function to reschedule."
(prog1 (cond
((oref session drill-answer)
(org-drill-with-replaced-entry-text
@@ -2058,6 +2070,7 @@ Note: does not actually alter the item."
(funcall reschedule-fn session))))))
(defun org-drill-present-simple-card-with-typed-answer (session)
+ "Present a simple card with a typed answer."
(org-drill-with-hidden-comments
(org-drill-with-hidden-cloze-hints
(org-drill-with-hidden-cloze-text
@@ -2070,6 +2083,7 @@ Note: does not actually alter the item."
(org-drill-hide-subheadings-if 'org-drill-entry-p))))))
(defun org-drill--show-latex-fragments ()
+ "Show latex fragment."
(org-remove-latex-fragment-image-overlays)
(org-toggle-latex-fragment '(4)))
- [nongnu] elpa/org-drill de1e419ae3 215/251: All more README tests, (continued)
- [nongnu] elpa/org-drill de1e419ae3 215/251: All more README tests, ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill 4f8b910347 224/251: Update documentation, ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill 6e812e7fef 211/251: Fix typo in function name in README, ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill 0444db69f5 210/251: fix reversed member arguments, ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill d1d7fde5e3 200/251: Regularize white space, ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill 2e37c8a91c 234/251: Merge branch 'fix/show-latex-fragments' into 'master', ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill 30913a9adf 247/251: Merge branch 'branweb/fix-cram-mode' into 'master', ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill 0f0ee9f188 241/251: Allow Creating New Session in Cram Mode, ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill ace0cf0dcd 250/251: Update CI., ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill 7b9b7f1323 209/251: Update documentation, ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill 546336d207 225/251: Update documentation.,
ELPA Syncer <=
- [nongnu] elpa/org-drill 602f5c4d96 243/251: Fix use of cl.el, ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill 94ae5d684d 244/251: update gitignore to exclude all org files in robots dir ending in -copy, ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill c65430b71a 045/251: Oops! some some nasty discrepancies have now been fixed.(something went wrong, ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill 7a3bf3ef30 092/251: Update version in header to 2.4.10., ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill b02735bde7 094/251: New option 'org-drill-cloze-length-matches-hidden-text': If non-nil, when, ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill 6c14bd6c50 129/251: Update robot, Fix remaining CL dependencies, ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill 11abbd2747 124/251: Add robotized test, ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill 46d71b5218 141/251: Add lexical-binding, ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill 2b44b36284 197/251: Fix prompt, ELPA Syncer, 2022/01/17
- [nongnu] elpa/org-drill 1429c675e8 191/251: Fix compatability call again!, ELPA Syncer, 2022/01/17