From a91c6101b9d81d1e19af6fb8edfbfdff3bd2b876 Mon Sep 17 00:00:00 2001 From: Phillip Lord Date: Sun, 30 Jun 2019 18:31:47 +0100 Subject: Update variable documentation --- org-drill.el | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/org-drill.el b/org-drill.el index 497a37e..293d7f2 100644 --- a/org-drill.el +++ b/org-drill.el @@ -228,6 +228,7 @@ rest of the expression after the string is a `hint', to be displayed instead of the hidden cloze during a test.") (defun org-drill--compute-cloze-regexp () + "Returns a regexp that detects clozes." (concat "\\(" (regexp-quote org-drill-left-cloze-delimiter) "[[:cntrl:][:graph:][:space:]]+?\\)\\(\\|" @@ -237,17 +238,23 @@ the hidden cloze during a test.") "\\)")) (defun org-drill--compute-cloze-keywords () + "Returns a fontification spec that detects cloze keywords." (list (list (org-drill--compute-cloze-regexp) (cl-copy-list '(1 'org-drill-visible-cloze-face nil)) (cl-copy-list '(2 'org-drill-visible-cloze-hint-face t)) - (cl-copy-list '(3 'org-drill-visible-cloze-face nil)) - ))) + (cl-copy-list '(3 'org-drill-visible-cloze-face nil))))) (defvar-local org-drill-cloze-regexp - (org-drill--compute-cloze-regexp)) + (org-drill--compute-cloze-regexp) + "Regexp that detects cloze. + +This is buffer-local variable.") (defvar-local org-drill-cloze-keywords - (org-drill--compute-cloze-keywords)) + (org-drill--compute-cloze-keywords) + "Fontification form for cloze. + +This is a buffer-local variable.") ;; Variables defining what keys can be pressed during drill sessions to quit the ;; session, edit the item, etc. -- cgit v1.2.3