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

Previous Next

Package: emacs;

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

Date: Tue, 28 Feb 2023 22:37:01 UTC

Severity: normal

Tags: patch

Done: Stefan Kangas <stefankangas <at> gmail.com>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#61877: closed ([PATCH] Extract Lisp function examples from
 shortdoc information)
Date: Wed, 06 Sep 2023 00:04:02 +0000
[Message part 1 (text/plain, inline)]
Your message dated Tue, 5 Sep 2023 17:03:39 -0700
with message-id <CADwFkmncHXwjvF-5W=Ehp0S_6xbmkL2aSUtPqJD3DWRH=ER3Nw <at> mail.gmail.com>
and subject line Re: bug#61877: [PATCH] Extract Lisp function examples from shortdoc information
has caused the debbugs.gnu.org bug report #61877,
regarding [PATCH] Extract Lisp function examples from shortdoc information
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
61877: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=61877
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
From: Daniel Martín <mardani29 <at> yahoo.es>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] Extract Lisp function examples from shortdoc information
Date: Tue, 28 Feb 2023 23:36:09 +0100
[Message part 3 (text/plain, inline)]
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.

[0001-Extract-Lisp-function-examples-from-shortdoc-informa.patch (text/x-patch, attachment)]
[Message part 5 (message/rfc822, inline)]
From: Stefan Kangas <stefankangas <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 61877-done <at> debbugs.gnu.org,
 Daniel Martín <mardani29 <at> yahoo.es>
Subject: Re: bug#61877: [PATCH] Extract Lisp function examples from shortdoc
 information
Date: Tue, 5 Sep 2023 17:03:39 -0700
Eli Zaretskii <eliz <at> gnu.org> writes:

>> Could you give a try to the attached patch, and install it for me if all
>> works correctly?  Thanks.
>
> It works here; I installed it.

I'm therefore closing this bug report.


This bug report was last modified 1 year and 310 days ago.

Previous Next


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