From mboxrd@z Thu Jan  1 00:00:00 1970
Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail
From: Eli Zaretskii <eliz@gnu.org>
Newsgroups: gmane.emacs.devel
Subject: Re: Patch proposal: display symbol source code in help buffers
Date: Mon, 20 Sep 2021 08:59:39 +0300
Message-ID: <83bl4n3hys.fsf@gnu.org>
References: <AM9PR09MB497721FD0F28CCD1FBAFBA0B96DF9@AM9PR09MB4977.eurprd09.prod.outlook.com>
Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214";
	logging-data="24914"; mail-complaints-to="usenet@ciao.gmane.io"
Cc: emacs-devel@gnu.org
To: Arthur Miller <arthur.miller@live.com>
Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Sep 20 08:01:20 2021
Return-path: <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>
Envelope-to: ged-emacs-devel@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 <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>)
	id 1mSCMh-0006I0-8G
	for ged-emacs-devel@m.gmane-mx.org; Mon, 20 Sep 2021 08:01:19 +0200
Original-Received: from localhost ([::1]:60546 helo=lists1p.gnu.org)
	by lists.gnu.org with esmtp (Exim 4.90_1)
	(envelope-from <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>)
	id 1mSCMg-0007Cd-4J
	for ged-emacs-devel@m.gmane-mx.org; Mon, 20 Sep 2021 02:01:18 -0400
Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:54370)
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <eliz@gnu.org>) id 1mSCLK-00062t-Hs
 for emacs-devel@gnu.org; Mon, 20 Sep 2021 01:59:54 -0400
Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:50078)
 by eggs.gnu.org with esmtp (Exim 4.90_1)
 (envelope-from <eliz@gnu.org>)
 id 1mSCLJ-0002bx-DR; Mon, 20 Sep 2021 01:59:53 -0400
Original-Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:1634
 helo=home-c4e4a596f7)
 by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <eliz@gnu.org>)
 id 1mSCLF-0007MF-3W; Mon, 20 Sep 2021 01:59:49 -0400
In-Reply-To: <AM9PR09MB497721FD0F28CCD1FBAFBA0B96DF9@AM9PR09MB4977.eurprd09.prod.outlook.com>
 (message from Arthur Miller on Sun, 19 Sep 2021 21:50:35 +0200)
X-BeenThere: emacs-devel@gnu.org
X-Mailman-Version: 2.1.23
Precedence: list
List-Id: "Emacs development discussions." <emacs-devel.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/emacs-devel>,
 <mailto:emacs-devel-request@gnu.org?subject=unsubscribe>
List-Archive: <https://lists.gnu.org/archive/html/emacs-devel>
List-Post: <mailto:emacs-devel@gnu.org>
List-Help: <mailto:emacs-devel-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/emacs-devel>,
 <mailto:emacs-devel-request@gnu.org?subject=subscribe>
Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org
Original-Sender: "Emacs-devel"
 <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>
Xref: news.gmane.io gmane.emacs.devel:275102
Archived-At: <http://permalink.gmane.org/gmane.emacs.devel/275102>

> From: Arthur Miller <arthur.miller@live.com>
> Date: Sun, 19 Sep 2021 21:50:35 +0200
> 
> Here is my second proposal to bring built-in help on par with external
> offerings.

Thanks.  Like Lars, I wonder why this is needed, given that we already
have a way to show the sources by a command invoked from the *Help*
buffer.  Can you tell how this feature makes a difference wrt what we
have already?

And a minor nit:

> * lisp/help-mode.el ('help-mode-inline-source'): New option.
> ('help--fetch-c-src'): New function.
> ('help--fetch-lisp-src'): New function.
> ('help--symbol-source'): New function.
> ('help-make-xrefs): Check for 'help-mode-inline-source' and
> call 'help--symbol-source' to perform insertion when possible.

We don't quote symbols inside the parentheses, only in the
descriptions that follow the colon, as you did in the last entry.

Thanks.