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: Sun, 17 Sep 2023 16:13:16 -0400 Message-ID: References: <87led6ghu8.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="6492"; 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 Sun Sep 17 22:14:18 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 1qhy9p-0001QS-QN for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 17 Sep 2023 22:14:18 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qhy9U-0000OZ-34; Sun, 17 Sep 2023 16:13:56 -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 1qhy9S-0000OQ-OF for bug-gnu-emacs@gnu.org; Sun, 17 Sep 2023 16:13:54 -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 1qhy9S-0008CX-GF for bug-gnu-emacs@gnu.org; Sun, 17 Sep 2023 16:13:54 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qhy9Z-0002cN-Mx for bug-gnu-emacs@gnu.org; Sun, 17 Sep 2023 16:14:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Monnier Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 17 Sep 2023 20:14:01 +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.169498161910027 (code B ref 66032); Sun, 17 Sep 2023 20:14:01 +0000 Original-Received: (at 66032) by debbugs.gnu.org; 17 Sep 2023 20:13:39 +0000 Original-Received: from localhost ([127.0.0.1]:51519 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qhy9C-0002be-G7 for submit@debbugs.gnu.org; Sun, 17 Sep 2023 16:13:39 -0400 Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:43477) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qhy96-0002bL-CG for 66032@debbugs.gnu.org; Sun, 17 Sep 2023 16:13:36 -0400 Original-Received: from pmg3.iro.umontreal.ca (localhost [127.0.0.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id A6829441111; Sun, 17 Sep 2023 16:13:18 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1694981597; bh=k1fK/kNIhcKlf07bds4iSCI0nGkPJQwwsMu01tSWYxw=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=jBWH6gOzvsmf+Tr2E9oyWuFO079OedrpcB/bKgPKbnmA40Na9M5pcXe6ogvBn468Z yG92HjlsGZWxQkGuNEPLUDJWug7ckyT1WO5HCwpoP3E/PZEU0bMkiX+XnIC9mvG4cc /XWAaZ3dI7uQRruejtN3gwbRBR7FrLcdYQ7PFO1keurjO+Su9E0TEJjNh1M7EJk+sL 8ah63jux/Cr+INScP0hnY93e4aVt6X7nJLctn2A+zST1vnU+OCwebeYhGCuShPMStV wvPJo4WWrXON4Msmeo3kk71awFi6BNFss1qm/WBdYp63YniVh393m33tcvRewaFN4W s2XOI9iyDW8Fg== Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id 40A864410FA; Sun, 17 Sep 2023 16:13:17 -0400 (EDT) Original-Received: from pastel (unknown [104.247.237.102]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 140F712027A; Sun, 17 Sep 2023 16:13:17 -0400 (EDT) In-Reply-To: <87led6ghu8.fsf@sappc2.fritz.box> (Jens Schmidt's message of "Sat, 16 Sep 2023 19:15:27 +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:270720 Archived-At: >>> But at least on one occasion Stefan has asked for a patch, and I >>> haven't seen yet patches that got declined. >> It does happen, tho. > From your detailed comments (thanks for those) I understand that a patch > for *this* bug would be, in principle, still welcome. It's been requested a few times, so we may as well, yes. I think ideally it should be fold(ed|able), but we don't have the infrastructure for that yet. > My advices' docstrings all start with verb in 3rd person singular, and > that looks awful if viewed standalone. (Showing off my standard > adherence here.) More seriously, I have been thinking about a > customizable option to control the inclusion of advice docstrings, but > nadvice.el seems to be too infrastructure-y for that. Maybe a halfway point is to include only the first line of the advice's docstring? >> The main problem I see, tho, is how to clearly "delimit" the >> docstring. Maybe we should indent the advice's docstring by two >> spaces or so? > Probably OK, but I'm afraid that lines get too long, then. We could consider this as a bug in the advice's docstring (i.e. decide&document that advices' docstrings should use fewer columns because they'll be displayed indented). > Do you think this docstring generation should be covered by ERT tests? ERT tests are always welcome, Stefan