[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#58602: 29.0.50; Please document (:documentation FORM) spec for closu
From: |
Stefan Monnier |
Subject: |
bug#58602: 29.0.50; Please document (:documentation FORM) spec for closures |
Date: |
Tue, 18 Oct 2022 09:34:29 -0400 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) |
Michael Heerdegen [2022-10-18 05:16:49] wrote:
> Stefan Monnier <monnier@iro.umontreal.ca> writes:
>> +Documentation strings are usually completely static, but occasionally
>> +it can be necessary to generate them dynamically. In some cases this
>> +can be done by writing a macro which will generate at compile time the
>> +code of the function, including the desired documentation string.
>> +But you can also generate the docstring at run-time
> I wonder: run-time or eval-time?
In my world these are two words to say the same thing.
>> + when the function
>> +is defined by writing @code{(:documentation @var{form})} instead of
>> +the documentation string@footnote{This only works in code using
>> +@code{lexical-binding}.}. Furthermore, you can also compute the
>> +documentation string on the fly when it is requested by setting
>> +the @code{function-documentation} property of the function's symbol to
>> +a Lisp form that should evaluate to a string.
>
> When is that form evaluated?
When the documentation string "is requested".
Stefan
- bug#58602: 29.0.50; Please document (:documentation FORM) spec for closures, Michael Heerdegen, 2022/10/17
- bug#58602: 29.0.50; Please document (:documentation FORM) spec for closures, Stefan Monnier, 2022/10/17
- bug#58602: 29.0.50; Please document (:documentation FORM) spec for closures, Christopher Dimech, 2022/10/17
- bug#58602: 29.0.50; Please document (:documentation FORM) spec for closures, Michael Heerdegen, 2022/10/17
- bug#58602: 29.0.50; Please document (:documentation FORM) spec for closures,
Stefan Monnier <=
- bug#58602: 29.0.50; Please document (:documentation FORM) spec for closures, Stefan Monnier, 2022/10/18
- bug#58602: 29.0.50; Please document (:documentation FORM) spec for closures, Drew Adams, 2022/10/18
- bug#58602: 29.0.50; Please document (:documentation FORM) spec for closures, Michael Heerdegen, 2022/10/18
- bug#58602: 29.0.50; Please document (:documentation FORM) spec for closures, Michael Heerdegen, 2022/10/19
- bug#58602: 29.0.50; Please document (:documentation FORM) spec for closures, Michael Albinus, 2022/10/20
- bug#58602: 29.0.50; Please document (:documentation FORM) spec for closures, Drew Adams, 2022/10/20