branch: externals/denote
commit 5faa2b41b0ed1d07f5951a1d271195cc2333f1d4
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Clarify denote-rename-file-using-front-matter doc
---
denote.el | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/denote.el b/denote.el
index 3392565a96..d1b5209a3e 100644
--- a/denote.el
+++ b/denote.el
@@ -1372,9 +1372,15 @@ The operation does the following:
;;;###autoload
(defun denote-rename-file-using-front-matter (file)
- "Rename current FILE using its front matter as input.
+ "Rename FILE using its front matter as input.
+When called interactively, FILE is the `buffer-file-name' which
+is subsequently inspected for the requisite front matter. It is
+thus implied that the FILE has a file type that is supported by
+Denote, per `denote-file-type'.
+
Ask for confirmation, showing the difference between the old and
-the new file names.
+the new file names. Refrain from performing the operation if the
+buffer has unsaved changes.
The identifier of the file, if any, is never modified even if it
is edited in the front matter: Denote considers the file name to
