[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#54732: 29.0.50; New `function-documentation`
From: |
Lars Ingebrigtsen |
Subject: |
bug#54732: 29.0.50; New `function-documentation` |
Date: |
Wed, 06 Apr 2022 11:29:46 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) |
Stefan Monnier <monnier@iro.umontreal.ca> writes:
> The patch below lifts this restriction by introducing a new generic
> function `function-documentation` to fetch the docstring of a function,
> which can then be implemented in various different ways depending on the
> OClosure's type.
Makes sense to me. Perhaps the doc string should also say that the
reason that `function-documentation' exists is to allow specialisation,
and that it should (probably) never be called from code directly,
instead of just saying that `documentation' is preferable:
+ "Extract the raw docstring info from FUNCTION.
+FUNCTION is expected to be a function value rather than, say, a mere symbol.
+It is usually preferable to call `documentation' which will call this
+function as needed."
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no