[elpa] externals/denote 4fb7c11b83 3/3: Clarify denote-rename-buffer-with-identifiier purpose

[ELPA Syncer]

branch: externals/denote
commit 4fb7c11b8351c3fb39f5f450bbce19b6cc733ede
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>

    Clarify denote-rename-buffer-with-identifiier purpose
    
    This is already explained in the user option and the manual, but it is
    good to have it here as well.
---
 denote-rename-buffer.el | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/denote-rename-buffer.el b/denote-rename-buffer.el
index dce5d50685..1118028658 100644
--- a/denote-rename-buffer.el
+++ b/denote-rename-buffer.el
@@ -78,7 +78,12 @@ extract the data you are looking for."
 (defun denote-rename-buffer-with-identifier (&optional buffer)
   "Retrieve Denote file of BUFFER and rename BUFFER based on the file 
identifier.
 BUFFER is an object that satisfies `bufferp'.  If nil, then use
-the return value of `current-buffer'."
+the return value of `current-buffer'.
+
+This is a generic reference implementation for use in the user
+option `denote-rename-buffer-function'.  If you need something
+else, check the Denote manual for functions/variables that
+extract the data you are looking for."
   (when-let* ((file-and-type (denote-rename-buffer--common-check (or buffer 
(current-buffer))))
               (identifier (denote-retrieve-filename-identifier (car 
file-and-type))))
     (rename-buffer identifier :unique)))