From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Monnier via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#66032: [PATCH] Inline advice documentation into advised function's docstring, after all Date: Sat, 23 Sep 2023 12:03:51 -0400 Message-ID: References: <87led6ghu8.fsf@sappc2.fritz.box> <87pm29nwh7.fsf@sappc2.fritz.box> Reply-To: Stefan Monnier Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="16871"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: 66032@debbugs.gnu.org, drew.adams@oracle.com To: Jens Schmidt Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Sep 23 18:05:16 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 1qk588-00049Q-26 for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 23 Sep 2023 18:05:16 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qk57q-0005Uf-2x; Sat, 23 Sep 2023 12:04:58 -0400 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 1qk57j-0005SW-KC for bug-gnu-emacs@gnu.org; Sat, 23 Sep 2023 12:04:52 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qk57i-0000XP-Qe for bug-gnu-emacs@gnu.org; Sat, 23 Sep 2023 12:04:51 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qk57u-0005IP-1e for bug-gnu-emacs@gnu.org; Sat, 23 Sep 2023 12:05:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Monnier Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 23 Sep 2023 16:05:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66032 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 66032-submit@debbugs.gnu.org id=B66032.169548505320271 (code B ref 66032); Sat, 23 Sep 2023 16:05:02 +0000 Original-Received: (at 66032) by debbugs.gnu.org; 23 Sep 2023 16:04:13 +0000 Original-Received: from localhost ([127.0.0.1]:40498 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qk577-0005Gt-FT for submit@debbugs.gnu.org; Sat, 23 Sep 2023 12:04:13 -0400 Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:59819) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qk574-0005Gc-EM for 66032@debbugs.gnu.org; Sat, 23 Sep 2023 12:04:11 -0400 Original-Received: from pmg2.iro.umontreal.ca (localhost.localdomain [127.0.0.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id 645208019D; Sat, 23 Sep 2023 12:03:53 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1695485032; bh=OjfpK8fh+cpytShUWZTyM/MpedKpzluxC8QCFFbDLO0=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=a2GQPyxN5H+4G6CL1+Z2LaJOMwe0S3oXS9Jq6ZBnDG/t+BorGoS+r/Q2Lw9SWOdt7 4c+0p3t/B3bRq/DyUztbIJdz5mXVADXn9XI4g6eS3bPcoKY2pJCKWaRXkmxOmT+oMA iJc/jqddxEHAXBtNK4DldaIDDPJMDPzK3JVlqskc3OrLM5RAnv660ap3Tx4at7BA+p TvPcy97fnsy/YVJ5i8KWEUt6fOSyrceZ6Z23JLsri5Gy6w3nzYPsCuPqGMhDvPYfhE fgLfSiCOrj2ipG14ycqJ/GIDLDvslL/fqADVut2acwxAy7RG33+v/xzkXS9sZdsAYi 2/5CbpAGGchcg== Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id 3F79880312; Sat, 23 Sep 2023 12:03:52 -0400 (EDT) Original-Received: from pastel (69-165-140-3.dsl.teksavvy.com [69.165.140.3]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 1596812013F; Sat, 23 Sep 2023 12:03:52 -0400 (EDT) In-Reply-To: <87pm29nwh7.fsf@sappc2.fritz.box> (Jens Schmidt's message of "Sat, 23 Sep 2023 10:07:48 +0200") 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:271173 Archived-At: > The documentation of the *function's advices*, however, is handled by > some function on `help-fns-describe-function-functions'. By default we > add a function `advice-describe-function-advices' (for you) but offer an > alternative one `advice-describe-detailed-function-advices' (for me and > others who have been asking for inlined docstrings). In principle this > works, as I have confirmed with a very rough prototype. That's an option as well (and it comes with the advantage that the list of advice can come after things like obsoletion info rather than before, which would be an improvement as well). I don't see any reason to reduce what is displayed by default (at least, nobody has asked for that, AFAIK), so the question is how to make it sufficiently easy to switch to a more detailed output. `remove-hook` of the default followed by `add-hook` of the other seems rather inconvenient. Stefan