branch: elpa/gnosis
commit 05cbcfc946a7c249ed7ba2d4f69e2569c4facabf
Author: Thanos Apollo <[email protected]>
Commit: Thanos Apollo <[email protected]>
[fix] docstring wranings.
---
gnosis-dashboard.el | 21 +++++++++++----------
gnosis.el | 5 +++--
2 files changed, 14 insertions(+), 12 deletions(-)
diff --git a/gnosis-dashboard.el b/gnosis-dashboard.el
index 7fc78785ab..3defcbb2c6 100644
--- a/gnosis-dashboard.el
+++ b/gnosis-dashboard.el
@@ -68,6 +68,8 @@ When non-nil, sort in ascending order (smaller values first)."
(defvar gnosis-dashboard--selected-ids nil
"Selected ids from the tabulated list.")
+(defvar gnosis-dashboard-themata-mode)
+
(defvar gnosis-dashboard-modules
'(gnosis-dashboard-module-header
gnosis-dashboard-module-today-stats
@@ -919,11 +921,11 @@ Returns list of (ID [TITLE LINK-COUNT BACKLINK-COUNT
THEMATA-LINKS-COUNT])."
nodes-data)))
(defun gnosis-dashboard-nodes--show-related (get-ids-fn no-results-msg
&optional display-fn)
- "Generic function to show related items for node at point.
+ "Show related items for the node at point.
-GET-IDS-FN is a function that takes a node-id and returns a list of related
IDs.
+GET-IDS-FN takes a node-id and returns related IDs.
NO-RESULTS-MSG is displayed when no related items are found.
-DISPLAY-FN is the function to display results (defaults to
`gnosis-dashboard-output-nodes')."
+DISPLAY-FN displays results, defaults to `gnosis-dashboard-output-nodes'."
(let* ((node-id (tabulated-list-get-id))
(related-ids (funcall get-ids-fn node-id))
(display-fn (or display-fn #'gnosis-dashboard-output-nodes)))
@@ -951,13 +953,12 @@ DISPLAY-FN is the function to display results (defaults
to `gnosis-dashboard-out
(defun gnosis-dashboard-nodes-show-themata-links ()
"Show themata that link to the node at point."
(interactive)
- (let ((node-id (tabulated-list-get-id)))
- ;; Clear themata history for fresh start in themata view
- (setq gnosis-dashboard-themata-history nil)
- (gnosis-dashboard-nodes--show-related
- #'gnosis-dashboard-get-themata-links
- "No themata link to this node"
- #'gnosis-dashboard-output-themata)))
+ ;; Clear themata history for fresh start in themata view
+ (setq gnosis-dashboard-themata-history nil)
+ (gnosis-dashboard-nodes--show-related
+ #'gnosis-dashboard-get-themata-links
+ "No themata link to this node"
+ #'gnosis-dashboard-output-themata))
(defun gnosis-dashboard-nodes-show-isolated ()
"Show isolated nodes (nodes with no connections at all).
diff --git a/gnosis.el b/gnosis.el
index 16e5ce4461..bdf5972290 100644
--- a/gnosis.el
+++ b/gnosis.el
@@ -670,7 +670,7 @@ If NAME is t, return name of deck."
(if name (gnosis--get-deck-name deck) deck)))
(cl-defun gnosis-toggle-suspend-themata (ids &optional verification)
- "Toggle Suspend value for thema with ID.
+ "Toggle Suspend value for themata IDS.
When VERIFICATION is non-nil, skips `y-or-n-p' prompt."
(cl-assert (listp ids) nil "IDS value needs to be a list.")
@@ -1589,6 +1589,7 @@ When `gnosis--id-cache' is bound, uses hash table for
existence check."
answer parathema tags suspend links)
"Default format for adding a thema.
+ID: Thema ID.
DECK-ID: Integer value of deck-id.
TYPE: String representing the type of thema.
KEIMENON: String for the thema text.
@@ -2022,7 +2023,7 @@ before importing into it."
(user-error "This function can only be used in org-mode buffers"))
(list (read-string "Deck name: " (gnosis-export-parse--deck-name)))))
(when (and (gnosis-get 'id 'decks `(= name ,deck-name))
- (not (y-or-n-p (format "Deck '%s' already exists. Import into it? "
+ (not (y-or-n-p (format "Deck '%s' already exists. Import into it?
"
deck-name))))
(user-error "Aborted"))
(let* ((gc-cons-threshold most-positive-fixnum)
