[elpa] externals/denote af2f2c0831 7/8: Clarify doc string of 'denote-desluggify'; add TODO for more

[ELPA Syncer]

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

    Clarify doc string of 'denote-desluggify'; add TODO for more
---
 denote.el | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/denote.el b/denote.el
index 6b1def15f1..404867d8f1 100644
--- a/denote.el
+++ b/denote.el
@@ -607,8 +607,14 @@ any leading and trailing signs."
   'denote-sluggify-keywords
   "1.0.0")
 
+;; TODO 2023-05-22: Review name of `denote-desluggify' to signify what
+;; the doc string warns about.
 (defun denote-desluggify (str)
-  "Upcase first char in STR and dehyphenate STR, inverting `denote-sluggify'."
+  "Upcase first char in STR and dehyphenate STR, inverting `denote-sluggify'.
+The intent of this function is to be used on individual strings,
+such as the TITLE component of a Denote file name, but not on the
+entire file name.  Put differently, it does not work with
+signatures and keywords."
   (let ((str (replace-regexp-in-string "-" " " str)))
     (aset str 0 (upcase (aref str 0)))
     str))