summaryrefslogtreecommitdiff
path: root/gnosis.el
diff options
context:
space:
mode:
authorThanos Apollo <[email protected]>2024-03-08 08:25:50 +0200
committerThanos Apollo <[email protected]>2024-03-08 08:33:09 +0200
commitcde06fe62754afc2e2df385e667669db9b853342 (patch)
tree46fa19cbf893c271b062839963023509bb38d78c /gnosis.el
parentcdd1a2cd71a11c2f326bc2b67987847cf44099ef (diff)
gnosis-add-note-mcq: Update docstring
Diffstat (limited to 'gnosis.el')
-rw-r--r--gnosis.el15
1 files changed, 6 insertions, 9 deletions
diff --git a/gnosis.el b/gnosis.el
index 4113ba4..5c38979 100644
--- a/gnosis.el
+++ b/gnosis.el
@@ -536,16 +536,13 @@ is the image to display post review
(defun gnosis-add-note-mcq ()
"Add note(s) of type `MCQ' interactively to selected deck.
-Create a note type MCQ for specified deck, that consists of:
-QUESTION: The question or problem statement
-OPTIONS: Options for the user to select
-ANSWER: Answer is the index NUMBER of the correct answer from OPTIONS.
-EXTRA: Information to display after user-input
-IMAGES: Cons cell, where car is the image to display before user-input
- and cdr is the image to display post review.
-TAGS: Used to organize notes
+Prompt user for input to create a note of type `MCQ'.
+
+Stem field is seperated from options by `gnosis-mcq-seperator', and
+each option is seperated by `gnosis-mcq-option-seperator'. The correct
+answer is surrounded by curly braces, e.g {Correct Answer}.
-Refer to `gnosis-add-note--mcq' for more."
+Refer to `gnosis-add-note--mcq' & `gnosis-prompt-mcq-input' for more."
(let ((deck (gnosis--get-deck-name)))
(while (y-or-n-p (format "Add note of type `MCQ' to `%s' deck? " deck))
(let* ((input (gnosis-prompt-mcq-input))