auctex-devel
[Top][All Lists]
Advanced

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

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


From: Arash Esbati
Subject: Re: doc string of TeX-read-key-val and multi-prompt-key-value
Date: Tue, 13 Dec 2022 09:35:33 +0100
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/30.0.50

Hi Keita,

Ikumi Keita <ikumi@ikumi.que.jp> writes:

> 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
> well:
> ,----
> | 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"))
>        ("name")
>        ("fileext")
>        ("within" ("chapter" "section" "subsection"))
>        ("relatedcapstyle" ("yes" "no")))))
> (taken from floatrow.el)
> [...]
> I think the doc string should be adapted accordingly. What do you think
> about it?

Good catch :-)  I think this should read:

  TABLE is an alist.  The first element of each list is a string
  representing a key and the optional second element is a list with
  strings to be used as values for the key.

Does is make sense?  Any comments welcome.

Best, Arash



reply via email to

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