From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#57974: 2022-08-30; Enhancing help facility for function doc string Date: Thu, 22 Sep 2022 13:13:54 +0200 Message-ID: <87czbn7jbh.fsf@gnus.org> References: <1509.1663752344@localhost> <871qs56iut.fsf@gnus.org> <6232.1663770080@localhost> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="13083"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) Cc: Stefan Monnier , 57974@debbugs.gnu.org To: Ikumi Keita Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Sep 22 14:40:25 2022 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 1obLVA-0003FJ-Ti for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 22 Sep 2022 14:40:24 +0200 Original-Received: from localhost ([::1]:47372 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1obLV9-00065e-H7 for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 22 Sep 2022 08:40:23 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:43674) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1obKAZ-0004We-4u for bug-gnu-emacs@gnu.org; Thu, 22 Sep 2022 07:15:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:37425) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1obKAY-0001N9-S2 for bug-gnu-emacs@gnu.org; Thu, 22 Sep 2022 07:15:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1obKAY-00078H-CV for bug-gnu-emacs@gnu.org; Thu, 22 Sep 2022 07:15:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 22 Sep 2022 11:15:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 57974 X-GNU-PR-Package: emacs Original-Received: via spool by 57974-submit@debbugs.gnu.org id=B57974.166384525427343 (code B ref 57974); Thu, 22 Sep 2022 11:15:02 +0000 Original-Received: (at 57974) by debbugs.gnu.org; 22 Sep 2022 11:14:14 +0000 Original-Received: from localhost ([127.0.0.1]:36503 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1obK9m-00076w-Bi for submit@debbugs.gnu.org; Thu, 22 Sep 2022 07:14:14 -0400 Original-Received: from quimby.gnus.org ([95.216.78.240]:53496) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1obK9h-00076e-AP for 57974@debbugs.gnu.org; Thu, 22 Sep 2022 07:14:13 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org; s=20200322; h=Content-Transfer-Encoding:Content-Type:MIME-Version:Message-ID :Date:References:In-Reply-To:Subject:Cc:To:From:Sender:Reply-To:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=SmGwX7spn21M51E6Y1xNquIkLVF8BNvMHnXzqXIQX9A=; b=cCIz/4MoVhnPWXaKhsN0eNVcMj Xj+JE60lkAQDZSJWJvXLfxuAOUXR7dD2mxQVLYmW8FVN5+U6egqsNIRYxSyG0Ebc09N+0EbShg0pl 8v4M//eOgRl9aihPn9jxyle97WrBmR+aCDqdmqcGyQ1WwLsGpQ1TbEP7SRVkMOMR3gtU=; Original-Received: from [84.212.220.105] (helo=joga) by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1obK9S-000835-QM; Thu, 22 Sep 2022 13:13:58 +0200 In-Reply-To: <6232.1663770080@localhost> (Ikumi Keita's message of "Wed, 21 Sep 2022 23:21:20 +0900") Face: iVBORw0KGgoAAAANSUhEUgAAADAAAAAwBAMAAAClLOS0AAAABGdBTUEAALGPC/xhBQAAACBj SFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAFVBMVEVJP0lmb5iopK/X 1NgbGCD49/f///8745hEAAAAAWJLR0QGYWa4fQAAAAd0SU1FB+YJFgsLNc25ygQAAAGHSURBVDjL ddTBjoMgEADQQdk7UHu3Q3tXSe9jwgdsa/z/X9kBwRVsJ2kaec4AExAAhNZaQQyBk3PO8s9tA9KT 9AHM+7m+HysH8LPkIdoyzIvBbiBJUgYIMKWMFDGP4VFDRDDjYx3PQBtcv2QMxwxe7Z5RAGTg0f5Y KicmWCLwDil7ApeAYxvXOFydSqVoBwLEoXn2/5NnIHsZftYzeK/b389gmy+A7W+79s8TkGpfn0G2 SwUydbcJcJwjdYTExGDdDjK3UtjLekeHZQb/QWPXu11cCdz1AFxqKSdnUA1yhiuXSyC1aqYF7FIu dzad7mc+rDUIknrkRLTVBoX0xvERRlMBn1MzhRdA2wL4yBuU8WDA9QjE05ue4qUQzyOQMPoF29m7 7kBcnGNM/Zz3lij+401gbnSGOQA/XrCLIDNotb1p7JA7vfUqgIxL0IdS6R6EsUblu3K4N8Ii2unm 266GmzLWvb27V+Cpmw3y3uPXwJcR1hGjBi6It/htOcHML0M1R1HzyzD8AZ6b4XXBm5FcAAAAJXRF WHRkYXRlOmNyZWF0ZQAyMDIyLTA5LTIyVDExOjExOjUzKzAwOjAwuM4f/wAAACV0RVh0ZGF0ZTpt b2RpZnkAMjAyMi0wOS0yMlQxMToxMTo1MyswMDowMMmTp0MAAAAASUVORK5CYII= X-Now-Playing: Carole King's _Tapestry_: "So Far Away" 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" Xref: news.gmane.io gmane.emacs.bugs:243413 Archived-At: Ikumi Keita writes: > The function A behaves as if it were the function B by the nature of > :override advice, so the doc string of A is almost useless. The actual > behavior is described by the doc string of B. > > Unfortunately, when A is a mode function and has a long doc string, > users can easily look over the line > This function has :override advice: =E2=80=98func-B=E2=80=99. > far downward in the *Help* buffer when they see the output of C-h m. > That results in that they miss the "true" mode description provided by > the doc string of B. > > Stephan suggested that such situation can be improved as > ,---- > | Maybe the help facility should be more careful in how it builds the > | docstring when a function has an `:override` advice, indeed. > `---- > , in https://lists.gnu.org/r/auctex-devel/2022-09/msg00046.html Right, makes sense. But there can be more than one advice -- would moving just the :overrides to the front of the doc string solve the problem?