branch: externals/denote
commit dc50c92ac82d6b3c157d551cfa0c09f30e8ad4a3
Author: Protesilaos Stavrou <[email protected]>
Commit: Protesilaos Stavrou <[email protected]>
Expand the doc string of denote-fontify-links-mode
---
denote.el | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/denote.el b/denote.el
index f79e7c36a9..a0cd1bfb70 100644
--- a/denote.el
+++ b/denote.el
@@ -6476,11 +6476,14 @@ Org or Markdown buffers automatically recognise Denote
links."
;;;###autoload
(define-minor-mode denote-fontify-links-mode
- "A minor mode to fontify and fold Denote links.
-
-Enabled this mode only when the current buffer is a Denote note and the
-major mode is not `org-mode' (or derived therefrom). Consider using
-`denote-fontify-links-mode-maybe' for this purpose."
+ "Fontify Denote links in plain text buffers.
+
+Enable this mode only when the current buffer is a Denote note and the
+major mode is not `org-mode' or `markdown-mode' (or any major mode
+derived therefrom). Consider using `denote-fontify-links-mode-maybe'
+instead of calling the function `denote-fontify-links-mode' directly
+because `denote-fontify-links-mode-maybe' will activate the mode only if
+necessary."
:init-value nil
:global nil
:group 'denote
