branch: externals/denote
commit 0eacf6673f184ec34f9c22ccb14e0e11a58c76f5
Author: Protesilaos Stavrou <[email protected]>
Commit: Protesilaos Stavrou <[email protected]>
Clarify the documentation of 'denote-backlinks-{next,prev}'
---
denote.el | 22 ++++++++++++++++------
1 file changed, 16 insertions(+), 6 deletions(-)
diff --git a/denote.el b/denote.el
index 0bbd60570f..f553cba535 100644
--- a/denote.el
+++ b/denote.el
@@ -3222,9 +3222,14 @@ Expand `denote-link-backlinks-display-buffer-action'."
(defun denote-backlinks-next (n)
"Use appropriate command for forward motion in backlinks buffer.
-With N as a numeric argument, move to the Nth button from
-point (relevant when `denote-backlinks-show-context' is nil). A
-nil value of N is understood as 1."
+With N as a numeric argument, move to the Nth button from point.
+A nil value of N is understood as 1.
+
+When `denote-backlinks-show-context' is nil, move between files
+in the backlinks buffer.
+
+When `denote-backlinks-show-context' is non-nil move between
+matching identifiers."
(interactive "p" denote-backlinks-mode)
(unless (derived-mode-p 'denote-backlinks-mode)
(user-error "Only use this in a Denote backlinks buffer"))
@@ -3234,9 +3239,14 @@ nil value of N is understood as 1."
(defun denote-backlinks-prev (n)
"Use appropriate command for backward motion in backlinks buffer.
-With N as a numeric argument, move to the Nth button from
-point (relevant when `denote-backlinks-show-context' is nil). A
-nil value of N is understood as 1."
+With N as a numeric argument, move to the Nth button from point.
+A nil value of N is understood as 1.
+
+When `denote-backlinks-show-context' is nil, move between files
+in the backlinks buffer.
+
+When `denote-backlinks-show-context' is non-nil move between
+matching identifiers."
(interactive "p" denote-backlinks-mode)
(unless (derived-mode-p 'denote-backlinks-mode)
(user-error "Only use this in a Denote backlinks buffer"))
