[Top][All Lists]

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

[elpa] externals/tmr 3a7b3833a9 3/4: Update manual about tmr-description

From: ELPA Syncer
Subject: [elpa] externals/tmr 3a7b3833a9 3/4: Update manual about tmr-descriptions-list
Date: Tue, 28 Jun 2022 02:58:05 -0400 (EDT)

branch: externals/tmr
commit 3a7b3833a9286b4807dbae6d2b9b1295e6045002
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>

    Update manual about tmr-descriptions-list
 README.org | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/README.org b/README.org
index d378b98cc3..6f31d7b9c1 100644
--- a/README.org
+++ b/README.org
@@ -88,18 +88,23 @@ The input can be a floating point:
 | 1.5   | 1.5 minutes (90 seconds) |
 | 1.5h  | 1.5 hours (90 minutes)   |
-#+vindex: tmr-descriptions-list
 If ~tmr~ is called with an optional prefix argument (=C-u= with default
 key bindings), it asks for a description to be associated with the given
-timer.  Preconfigured candidates, as a list of strings, are specified in
-the user option ~tmr-descriptions-list~, though any arbitrary input is
-acceptable at the minibuffer prompt.
 #+findex: tmr-with-description
 An alternative to the ~tmr~ command is ~tmr-with-description~.  The
 difference between the two is that the latter always prompts for a
+#+vindex: tmr-descriptions-list
+The user option ~tmr-descriptions-list~ defines the completion
+candidates that are shown at the description prompt.  Its value can be
+either a list of strings or the symbol of a variable that holds a list
+of strings.  The default value of ~tmr-description-history~, is the name
+of a variable that contains input provided by the user at the relevant
+prompt of the ~tmr~ and ~tmr-with-description~ commands.
 When the timer is set, a message is sent to the echo area recording the
 current time and the point in the future when the timer elapses.  Echo
 area messages can be reviewed with the ~view-echo-area-messages~ which
@@ -304,6 +309,8 @@ Everything is in place to set up the package.
 (setq tmr-notification-urgency 'normal)
+;; Read the `tmr-descriptions-list' doc string
 (setq tmr-descriptions-list (list "Boil water" "Prepare tea" "Bake bread"))
 ;; OPTIONALLY set global key bindings:

reply via email to

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