branch: externals/denote
commit 927c862685f70cb68841e0073137210d27ecddde
Author: Protesilaos Stavrou <[email protected]>
Commit: Protesilaos Stavrou <[email protected]>
Reword the doc string of denote--file-with-temp-buffer
This follows the change made by duli in commit 0f71f12 via pull
request 672: <https://github.com/protesilaos/denote/pull/672>. The
author of the original change has assigned copyright to the Free
Software Foundation.
Also thanks to Jean-Philippe Gagné Guay for reviewing the change and
for reporting a problem with an earlier version of the code in issue
670: <https://github.com/protesilaos/denote/issues/670>.
---
denote.el | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/denote.el b/denote.el
index 358db62ae8..8634c94424 100644
--- a/denote.el
+++ b/denote.el
@@ -2625,8 +2625,10 @@ Also see `denote-extract-keywords-from-path' (alias
(match-string 1 filename))))
(defmacro denote--file-with-temp-buffer (file &rest body)
- "If a buffer is visiting FILE, insert its contents into a temporary
-buffer. Otherwise, insert the contents of FILE. Then call BODY."
+ "Evaluate BODY with FILE contents in scope.
+If a buffer is visiting FILE, insert the buffer contents into a
+temporary buffer. Otherwise, insert the contents of FILE. Then call
+BODY."
(declare (indent 1))
`(let* ((buffer (get-file-buffer ,file))
(file-exist (file-exists-p ,file)))