summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThanos Apollo <[email protected]>2024-01-27 09:55:21 +0200
committerThanos Apollo <[email protected]>2024-01-27 11:31:31 +0200
commit211706458b81ea3d2aafa2d58d2c4fe2f97e5a60 (patch)
treef92fa7ef7b66ab8c0c1e8f9108fccb305e32e750
parent38aa8af4168219089f07e3824cea9e9193d13d03 (diff)
Update docstrings & indentation style
-rw-r--r--gnosis.el9
1 files changed, 6 insertions, 3 deletions
diff --git a/gnosis.el b/gnosis.el
index ef02b46..e29de71 100644
--- a/gnosis.el
+++ b/gnosis.el
@@ -182,7 +182,7 @@ Example:
(emacsql gnosis-db `[:update ,table :set ,value :where ,where]))
(cl-defun gnosis-get (value table &optional (restrictions '1=1))
- "Return VALUE from TABLE, optionally with where RESTRICTIONS."
+ "Return caar of VALUE from TABLE, optionally with where RESTRICTIONS."
(caar (gnosis-select value table restrictions)))
(defun gnosis-get-note-tags (id)
@@ -1033,7 +1033,9 @@ NOTE-NUM: The number of notes reviewed in the session."
(message "Review session finished. %d notes reviewed." note-num)))
(defun gnosis-review--session (notes)
- "Start review session for NOTES."
+ "Start review session for NOTES.
+
+NOTES: List of note ids"
(let ((note-count 0))
(if (null notes)
(message "No notes for review.")
@@ -1331,7 +1333,8 @@ review."
(pcase review-type
("Due notes" (gnosis-review--session (gnosis-review-get-due-notes)))
("Due notes of deck" (gnosis-review--session (gnosis-get-deck-due-notes)))
- ("Due notes of specified tag(s)" (gnosis-review--session (gnosis-select-by-tag (gnosis-tag-prompt :match t :due t))))
+ ("Due notes of specified tag(s)" (gnosis-review--session
+ (gnosis-select-by-tag (gnosis-tag-prompt :match t :due t))))
("All notes of tag(s)" (gnosis-review--session (gnosis-select-by-tag (gnosis-tag-prompt :match t)))))))
;;; Database Schemas