From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Gregory Heytings via "Emacs development discussions." Newsgroups: gmane.emacs.devel Subject: RE: master 2a7488d: Add support for displaying short documentation for function groups Date: Mon, 12 Oct 2020 08:05:00 +0000 Message-ID: References: <20201011035127.7723.3256@vcs0.savannah.gnu.org> <20201011035128.E3FD320667@vcs0.savannah.gnu.org> <87k0vxquvo.fsf@gnus.org> <83o8l850v5.fsf@gnu.org> <87k0vwfn99.fsf@gnus.org> <10ee24ac-7f59-437a-bee9-ec6d848d927d@default> Reply-To: Gregory Heytings Mime-Version: 1.0 Content-Type: text/plain; format=flowed; charset=US-ASCII Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="4206"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Alpine 2.22 (NEB 394 2020-01-19) Cc: Lars Ingebrigtsen , Eli Zaretskii , emacs-devel@gnu.org To: Drew Adams Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Oct 12 10:06:04 2020 Return-path: 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 ) id 1kRsqK-0000wU-Gn for ged-emacs-devel@m.gmane-mx.org; Mon, 12 Oct 2020 10:06:04 +0200 Original-Received: from localhost ([::1]:48910 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kRsqJ-0006Ny-GI for ged-emacs-devel@m.gmane-mx.org; Mon, 12 Oct 2020 04:06:03 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:46130) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kRspY-0005qp-9g for emacs-devel@gnu.org; Mon, 12 Oct 2020 04:05:16 -0400 Original-Received: from mx.sdf.org ([205.166.94.24]:63968) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kRspV-0004TA-Rw; Mon, 12 Oct 2020 04:05:15 -0400 Original-Received: from sdf.org (IDENT:ghe@otaku.sdf.org [205.166.94.8]) by mx.sdf.org (8.15.2/8.14.5) with ESMTPS id 09C854o7029922 (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256 bits) verified NO); Mon, 12 Oct 2020 08:05:04 GMT Original-Received: (from ghe@localhost) by sdf.org (8.15.2/8.12.8/Submit) id 09C85PGA021974; Mon, 12 Oct 2020 08:05:25 GMT In-Reply-To: <10ee24ac-7f59-437a-bee9-ec6d848d927d@default> Received-SPF: pass client-ip=205.166.94.24; envelope-from=ghe@sdf.org; helo=mx.sdf.org X-detected-operating-system: by eggs.gnu.org: First seen = 2020/10/12 04:05:08 X-ACL-Warn: Detected OS = ??? X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:257450 Archived-At: >> I think the manual gives superior information in most cases, so I'd >> really like this to link to the manual and not the doc strings. This >> is also a way to guide users into the manual and read more in-depth >> about not just the functions described, but the machinery surrounding >> them, giving them more context. > > *Help* should have a link to the relevant manual node. See thread "How > to make Emacs popular again." That's not hard to do, and it's been done > (e.g. in `help-fns+.el'). > As I already explained repeatedly, this is _not_ the meaning of my proposal in that thread. My proposal is to _manually_ add pointers to the relevant manual _chapters_ in docstrings. For example, the docstring of kill-buffer would have two links, one to (info "(emacs)Buffers") and another one to (info "(elisp)Buffers"), with some explanation. For example: See also the following manual chapters: for interactive use, see `(emacs) Buffers'; for Emacs Lisp programming use, see `(elisp) Buffers'. Your proposal is to merge a feature of help-fns+.el in help-fns.el. This feature adds a link in *Help* buffers, and when the user clicks on that link the indexes of a (user chosen) list of manuals are checked to see if they contain pointers to the subject of the *Help* buffer. Doing this is, as you said yourself, inefficient. The result of this scan is presented in another buffer as a list of links, and when the user clicks on these links the place where the subject of the *Help* buffer is documented in the manual is displayed. These are two very different proposals.