GNU bug report logs - #54732
29.0.50; New `function-documentation`

Previous Next

Full log

View this message in rfc822 format

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 54732 <at> debbugs.gnu.org
Subject: bug#54732: 29.0.50; New `function-documentation`
Date: Wed, 06 Apr 2022 11:29:46 +0200

Stefan Monnier <monnier <at> 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

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.