emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/denote 0e0a6e44f1 1/2: Update the denote-prompts docume


From: ELPA Syncer
Subject: [elpa] externals/denote 0e0a6e44f1 1/2: Update the denote-prompts documentation to reflect its current state
Date: Sun, 24 Mar 2024 03:58:41 -0400 (EDT)

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

    Update the denote-prompts documentation to reflect its current state
---
 README.org | 25 ++++++++++++++++++-------
 denote.el  | 20 ++++++++++++--------
 2 files changed, 30 insertions(+), 15 deletions(-)

diff --git a/README.org b/README.org
index fd7fc4f8e3..cfedd3d4c0 100644
--- a/README.org
+++ b/README.org
@@ -208,11 +208,25 @@ alias ~denote-create-note~.
 :CUSTOM_ID: h:f9204f1f-fcee-49b1-8081-16a08a338099
 :END:
 
+[ As part of {{{development-version}}}, all commands that produce or
+  modify a Denote file name are revised to do their work while
+  conforming with the value of ~denote-prompts~, where that is
+  reasonable to do. ]
+
 #+vindex: denote-prompts
 The user option ~denote-prompts~ determines how the ~denote~ command
 will behave interactively ([[#h:6a92a8b5-d766-42cc-8e5b-8dc255466a23][Standard 
note creation]]).
 
-The value is a list of symbols, which includes any of the following:
+Commands that prompt for user input to construct a Denote file name
+include, but are not limited to: ~denote~, ~denote-signature~,
+~denote-type~, ~denote-date~, ~denote-subdirectory~,
+~denote-rename-file~, ~denote-dired-rename-files~.
+
+- [[#h:887bdced-9686-4e80-906f-789e407f2e8f][Convenience commands for note 
creation]].
+- [[#h:532e8e2a-9b7d-41c0-8f4b-3c5cbb7d4dca][Renaming files]].
+
+The value of this user option is a list of symbols, which includes any
+of the following:
 
 - =title=: Prompt for the title of the new note 
([[#h:403422a7-7578-494b-8f33-813874c12da3][The 
~denote-history-completion-in-prompts~ option]]).
 
@@ -278,12 +292,9 @@ those permutations:
 When in doubt, always include the =title= and =keywords= prompts.
 
 Finally, this user option only affects the interactive use of the
-~denote~ command (advanced users can call it from Lisp).  For ad-hoc
-interactive actions that do not change the default behaviour of the
-~denote~ command, users can invoke these convenience commands:
-~denote-type~, ~denote-subdirectory~, ~denote-date~,
-~denote-signature~.  They are described in the subsequent section
-([[#h:887bdced-9686-4e80-906f-789e407f2e8f][Convenience commands for note 
creation]]).
+~denote~ or other relevant commands (advanced users can call it from
+Lisp). In Lisp usage, the behaviour is always what the caller
+specifies, based on the supplied arguments.
 
 *** The ~denote-history-completion-in-prompts~ option
 :PROPERTIES:
diff --git a/denote.el b/denote.el
index bc93335837..b15be12797 100644
--- a/denote.el
+++ b/denote.el
@@ -197,9 +197,15 @@ the appropriate list of strings."
   :type 'boolean)
 
 (defcustom denote-prompts '(title keywords)
-  "Specify the prompts of the `denote' command for interactive use.
+  "Specify the prompts followed by relevant Denote commands.
 
-The value is a list of symbols, which includes any of the following:
+Commands that prompt for user input to construct a Denote file name
+include, but are not limited to: `denote', `denote-signature',
+`denote-type', `denote-date', `denote-subdirectory',
+`denote-rename-file', `denote-dired-rename-files'.
+
+The value of this user option is a list of symbols, which includes any
+of the following:
 
 - `title': Prompt for the title of the new note.
 
@@ -272,15 +278,13 @@ When in doubt, always include the `title' and `keywords'
 prompts (the default style).
 
 Finally, this user option only affects the interactive use of the
-`denote' command (advanced users can call it from Lisp).  For
-ad-hoc interactive actions that do not change the default
-behaviour of the `denote' command, users can invoke these
-convenience commands: `denote-type', `denote-subdirectory',
-`denote-date', `denote-template', `denote-signature'.
+`denote' or other relevant commands (advanced users can call it from
+Lisp).  In Lisp usage, the behaviour is always what the caller
+specifies, based on the supplied arguments.
 
 Also see `denote-history-completion-in-prompts'."
   :group 'denote
-  :package-version '(denote . "2.0.0")
+  :package-version '(denote . "2.3.0")
   :link '(info-link "(denote) The denote-prompts option")
   :type '(radio (const :tag "Use no prompts" nil)
                 (set :tag "Available prompts" :greedy t



reply via email to

[Prev in Thread] Current Thread [Next in Thread]