[Top][All Lists]

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

doc string of TeX-read-key-val and multi-prompt-key-value

From: Ikumi Keita
Subject: doc string of TeX-read-key-val and multi-prompt-key-value
Date: Mon, 12 Dec 2022 18:02:01 +0900

Hi, all

Here is a quote from the doc string explaining KEY-VAL-ALIST argument
of `TeX-read-key-val'. `multi-prompt-key-value' has the same phrase as
| The car of each element should be a string representing a key and
| the optional cdr should be a list with strings to be used as
| values for the key.
The description about the cdr isn't correct. In the actual
implementation, KEY-VAL-ALIST argument of `TeX-read-key-val'
is given in a form like
      (("placement" ("tbp" "t" "b" "p"))
       ("within" ("chapter" "section" "subsection"))
       ("relatedcapstyle" ("yes" "no")))))
(taken from floatrow.el)
The cdr of the first element is (("tbp" "t" "b" "p")), not "a list with
strings". Actually, when I evaluate
(TeX-read-key-val nil '(("foo" "1" "2" "3")))
and type f o o = TAB, emacs signals an error complaining
(invalid-function "1")
. We need instead
(TeX-read-key-val nil '(("foo" ("1" "2" "3"))))

I think the doc string should be adapted accordingly. What do you think
about it?

Ikumi Keita
#StandWithUkraine #StopWarInUkraine

reply via email to

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