[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/denote 05e70d4e5c 11/39: Update doc strings of convenie
From: |
ELPA Syncer |
Subject: |
[elpa] externals/denote 05e70d4e5c 11/39: Update doc strings of convenience commands |
Date: |
Mon, 11 Jul 2022 00:57:44 -0400 (EDT) |
branch: externals/denote
commit 05e70d4e5c6f97343d5c84996d9bdf303fd81687
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>
Update doc strings of convenience commands
---
denote.el | 29 +++++++++++++++++++----------
1 file changed, 19 insertions(+), 10 deletions(-)
diff --git a/denote.el b/denote.el
index e5fa42986c..7f924d6fb0 100644
--- a/denote.el
+++ b/denote.el
@@ -196,8 +196,8 @@ The value is a list of symbols, which includes any of the
following:
- `subdirectory': Prompts with completion for a subdirectory in
which to create the note. Available candidates are the value
of the user option `denote-directory' and all of its
- subdirectories (except .git). Any subdirectory must already
- exist: Denote will not create it.
+ subdirectories. Any subdirectory must already exist: Denote
+ will not create it.
The prompts will happen in the given order.
@@ -779,10 +779,11 @@ here for clarity."
;;;###autoload
(defun denote-type ()
- "Convenience function to have `denote' prompt for a date.
+ "Create note while prompting for a file type.
-This is equivalent to calling `denote' when `denote-prompts' is set to
-'(file-type title keywords)."
+This is the equivalent to calling `denote' when `denote-prompts'
+is set to \\'(file-type title keywords)."
+ (declare (interactive-only t))
(interactive)
(let ((denote-prompts '(file-type title keywords)))
(call-interactively #'denote)))
@@ -821,10 +822,14 @@ NO-CHECK-CURRENT passes the appropriate flag to
;;;###autoload
(defun denote-date ()
- "Convenience function to have `denote' prompt for a date.
+ "Create note while prompting for a date.
-This is equivalent to calling `denote' when `denote-prompts' is set to
-'(date title keywords)."
+The date can be in YEAR-MONTH-DAY notation like 2022-06-30 or
+that plus the time: 2022-06-16 14:30
+
+This is the equivalent to calling `denote' when `denote-prompts'
+is set to \\'(date title keywords)."
+ (declare (interactive-only t))
(interactive)
(let ((denote-prompts '(date title keywords)))
(call-interactively #'denote)))
@@ -867,10 +872,14 @@ This is equivalent to calling `denote' when
`denote-prompts' is set to
;;;###autoload
(defun denote-subdirectory ()
- "Convenience function to have `denote' prompt for subdirectory.
+ "Create note while prompting for a subdirectory.
+
+Available candidates include the value of the variable
+`denote-directory' and any subdirectory thereof.
This is equivalent to calling `denote' when `denote-prompts' is set to
-'(subdirectory title keywords)."
+\\'(subdirectory title keywords)."
+ (declare (interactive-only t))
(interactive)
(let ((denote-prompts '(subdirectory title keywords)))
(call-interactively #'denote)))
- [elpa] externals/denote 92e15886d5 20/39: Avoid errors with string value for keywords, (continued)
- [elpa] externals/denote 92e15886d5 20/39: Avoid errors with string value for keywords, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 5761ec5f89 34/39: BREAKING update journal samples for current 'denote', ELPA Syncer, 2022/07/11
- [elpa] externals/denote b05ea22a11 05/39: Add private function to normalise denote-prompts, ELPA Syncer, 2022/07/11
- [elpa] externals/denote d8ae24a80f 13/39: Merge branch 'main' into refactor-denote-prompts, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 8ea2a7b65d 30/39: Tweak denote-prompts doc string, ELPA Syncer, 2022/07/11
- [elpa] externals/denote d1a3fe3989 31/39: Revise manual on note creation; add denote-prompts, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 2c0727eb37 32/39: Add :link to manual in 'denote-prompts' definition, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 9cdd77d425 10/39: Add TODO for 'denote' command Lisp arguments, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 258ddc7b2c 02/39: Update denote-prompts doc string, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 0326ab3d75 04/39: Add TODO for denote-prompts value, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 05e70d4e5c 11/39: Update doc strings of convenience commands,
ELPA Syncer <=
- [elpa] externals/denote c2c0d74dc1 16/39: Fix typo in denote-prompts doc string, ELPA Syncer, 2022/07/11
- [elpa] externals/denote c56ddd3fb9 19/39: Update doc string of 'denote' command, ELPA Syncer, 2022/07/11
- [elpa] externals/denote a283cc1139 21/39: Revert "Avoid errors with string value for keywords", ELPA Syncer, 2022/07/11
- [elpa] externals/denote 4cae3d4262 24/39: Rename args in 'denote' for consistency, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 23cebf0fe5 26/39: Simplify 'denote' doc string about TITLE arg, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 840ffc522f 27/39: Reword and expand doc string of 'denote-prompts', ELPA Syncer, 2022/07/11
- [elpa] externals/denote 084bd4656e 28/39: Clarify interactivity for 'denote-prompts', ELPA Syncer, 2022/07/11
- [elpa] externals/denote b4b08f28e5 29/39: Improve denote-prompts reference to other commands, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 21d0485649 35/39: Update sample configuration, ELPA Syncer, 2022/07/11
- [elpa] externals/denote bce2c1b567 37/39: Fix index of 'denote' arguments, ELPA Syncer, 2022/07/11