From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#61877: [PATCH] Extract Lisp function examples from shortdoc information Date: Sat, 11 Mar 2023 10:37:54 +0200 Message-ID: <837cvny97h.fsf@gnu.org> References: Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="30164"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 61877@debbugs.gnu.org To: Daniel =?UTF-8?Q?Mart=C3=ADn?= Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Mar 11 09:39:21 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1paul7-0007cR-93 for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 11 Mar 2023 09:39:21 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1paukq-0003PP-22; Sat, 11 Mar 2023 03:39:04 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pauko-0003JM-Pr for bug-gnu-emacs@gnu.org; Sat, 11 Mar 2023 03:39:02 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pauko-0003mv-G1 for bug-gnu-emacs@gnu.org; Sat, 11 Mar 2023 03:39:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pauko-0006DI-5k for bug-gnu-emacs@gnu.org; Sat, 11 Mar 2023 03:39:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 11 Mar 2023 08:39:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 61877 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 61877-submit@debbugs.gnu.org id=B61877.167852389823832 (code B ref 61877); Sat, 11 Mar 2023 08:39:02 +0000 Original-Received: (at 61877) by debbugs.gnu.org; 11 Mar 2023 08:38:18 +0000 Original-Received: from localhost ([127.0.0.1]:56502 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pauk5-0006CJ-IM for submit@debbugs.gnu.org; Sat, 11 Mar 2023 03:38:17 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:36090) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pauk3-0006C5-Np for 61877@debbugs.gnu.org; Sat, 11 Mar 2023 03:38:16 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1paujy-0003jI-F3; Sat, 11 Mar 2023 03:38:10 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-version:References:Subject:In-Reply-To:To:From: Date; bh=DWAkF02KswT+5uO1WMCqe95ptq3DUd96Lt1YXVdlPeI=; b=JDJL6M07HaJ3q/YtPFJK vPGfRdpvIwZ97CcY3cMST1Ppq3BuaFYYYNnNKrGCfhTITML4Y54Ue1DUaPeG+U7cx5qCoH/rP9xbr 2YH7X8WUX/jU9sm8k647EBjUhwdG57RolHBXba45cPL0RYBc268/vrz8gZ2p3F9U/sTJBc6jcDOcj Nk18YB9IjJ6vojpb/jz2nNclHWeiET/hPYbv5LYoxdcght5h0q4qvjZgcjh9N2AnkVC82Rksq+I5y q8jqLwj9PVuKrMG//X2ApHG48wd7ULld7tBgPwJr2/fixPPMriu8eIqeb9ts3hzFpbqKzuUUy1nzR EDeNzm/DDJy8Ig==; Original-Received: from [87.69.77.57] (helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1paujx-0002fD-MF; Sat, 11 Mar 2023 03:38:10 -0500 In-Reply-To: (bug-gnu-emacs@gnu.org) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:257763 Archived-At: > Date: Thu, 02 Mar 2023 22:38:42 +0100 > From: Daniel Martín via "Bug reports for GNU Emacs, > the Swiss army knife of text editors" > > Daniel Martín 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. Thanks. This no longer applies to the current master, so please resubmit, and I will install. > The NEWS entry explains how users could show this information in their > *Help* buffers, if they want. Maybe this part should be also in the user manual?