GNU bug report logs - #61877
[PATCH] Extract Lisp function examples from shortdoc information

Previous Next

Full log

View this message in rfc822 format

From: Daniel Martín <mardani29 <at> yahoo.es>
To: 61877 <at> debbugs.gnu.org
Subject: bug#61877: [PATCH] Extract Lisp function examples from shortdoc information
Date: Thu, 02 Mar 2023 22:38:42 +0100

[Message part 1 (text/plain, inline)]

Daniel Martín <mardani29 <at> yahoo.es> writes:

> Shortdoc contains a lot of useful examples about how to use common ELisp
> functions.  This patch explores a new Emacs feature where those examples
> are identified and extracted so they can be displayed, perhaps, in
> *Help* buffers (via an additional help-fns-describe-function-functions
> hook).
>
> After you install the attached patch, take a look at the *Help* buffer
> produced by C-h f assq RET, or C-h f match-string RET, etc.
>
> What do you think of having this new Lisp feature in Emacs 30?  I can
> send later another patch with tests, relevant NEWS entries and
> documentation changes.
>
> Thanks.

I attach a second version of the patch.  I've confined the
implementation to shortdoc.el, added a test, and documented the new
functions.

The NEWS entry explains how users could show this information in their
*Help* buffers, if they want.

Thanks.

[0001-Add-functions-to-query-Emacs-Lisp-examples-registere.patch (text/x-patch, attachment)]

Previous Next

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