From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: =?UTF-8?Q?Cl=C3=A9ment?= Pit-Claudel Newsgroups: gmane.emacs.bugs Subject: bug#50222: Advising a function pollutes its docstring Date: Thu, 26 Aug 2021 23:25:15 -0400 Message-ID: Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="p7XXc5PqLnPeEg5sg5t64O4i1u931Iv94" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="20849"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.11.0 Cc: Stefan Monnier To: 50222@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Aug 27 05:33:14 2021 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 1mJScC-00057x-Gv for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 27 Aug 2021 05:33:14 +0200 Original-Received: from localhost ([::1]:49732 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mJScA-00082k-MD for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 26 Aug 2021 23:33:10 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:50904) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mJSa6-0005tt-Ln for bug-gnu-emacs@gnu.org; Thu, 26 Aug 2021 23:31:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:39396) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mJSa6-0008Tl-Dx for bug-gnu-emacs@gnu.org; Thu, 26 Aug 2021 23:31:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mJSa6-0002Kv-7a; Thu, 26 Aug 2021 23:31:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: =?UTF-8?Q?Cl=C3=A9ment?= Pit-Claudel Original-Sender: "Debbugs-submit" Resent-CC: monnier@iro.umontreal.ca, bug-gnu-emacs@gnu.org Resent-Date: Fri, 27 Aug 2021 03:31:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 50222 X-GNU-PR-Package: emacs X-Debbugs-Original-To: bug-gnu-emacs X-Debbugs-Original-Xcc: : Stefan Monnier Original-Received: via spool by submit@debbugs.gnu.org id=B.16300350578741 (code B ref -1); Fri, 27 Aug 2021 03:31:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 27 Aug 2021 03:30:57 +0000 Original-Received: from localhost ([127.0.0.1]:50941 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mJSZy-0002DU-7D for submit@debbugs.gnu.org; Thu, 26 Aug 2021 23:30:57 -0400 Original-Received: from lists.gnu.org ([209.51.188.17]:49796) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mJSZt-00029O-Dj for submit@debbugs.gnu.org; Thu, 26 Aug 2021 23:30:52 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:50804) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mJSZq-0005k0-Co for bug-gnu-emacs@gnu.org; Thu, 26 Aug 2021 23:30:47 -0400 Original-Received: from mail-vi1eur06olkn20826.outbound.protection.outlook.com ([2a01:111:f400:fe11::826]:35809 helo=EUR06-VI1-obe.outbound.protection.outlook.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mJSZl-0007zx-9J for bug-gnu-emacs@gnu.org; Thu, 26 Aug 2021 23:30:45 -0400 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=JFQ+08KVjn21Jgf4dg6hlPQ7P0Jrf64A6G9gs9i55X62noqpd6mad1JfKsRsafRJQaGf+Edbfhs4ItUQsRGxahWp5f/g/gcXWihVEn2x+/F8hnAXLosQ5rC5hpJdSBp/qM/RRwgYu6YVHVzdirM41vNmYE/xrnurtqqYYYhaQuvbTSM2UVGgJLoTLa3ql+Ss4PM3HdSSQ0gt5oGCtXfLe3kdWtRROgnA2GyQNr+PyHhdSsVjhQpPzS6cvwP0ZXXWPptjheAdpGpoOgMrtYOF28NK7faQ6DGNzOmVro3mFVcUoqa/nxMyMC6F96Tiq25iDc0pGLK+qc2DDrkCqUfb5w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=/Aun97mRorSt6fYYAPZTKwoXtbqcyeBsNCfu6P1fDeU=; b=G2UfQVTjGA1FWkm3EtLFIgOqLY0I73Mbgxpvu/N+gv4jaxXn8OjdPy5F6JXFmUX4qR5L796pYgaL5cG/pTky5WOhhxrlRUi85hL5sZG6AV7tOrO7SoHQzHcZMF0CmJJB9iEJhK/jxieSY3CYh+kgM3bVl2wNq/LLFnENrha7cB0087ckfOFPqiQHMlJSiJajd78eTJqhzdOYeWvkRqd8miwSlXER589keiAvby0f18YtxACFfYUM1SCf9XQ7LkbKwtKo1ymj7+w9tX2SB8JU94L6tNa7w03rh7P7CSxsPDYfnDEjgzDQxivtb8KY1pkIHHtzHSgAaUtM57kmdrMsYQ== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=none; dmarc=none; dkim=none; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=live.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=/Aun97mRorSt6fYYAPZTKwoXtbqcyeBsNCfu6P1fDeU=; b=jT0XA/iWufwACOseb+4WiyibnSO1c2M9A7+r0CwQa8+8Kg4rcwcEAekXFsDu4P7eHFQhQ03yaIzmz2Age+RK5c1bIWyZWXU/EViXbcToPDBk5ApiPJLH5ZyRCBdTsdNhr0oAklZD7yCiFGfnUD+3o5+cFQnJu28p9FbsPSa80ILXNFJoNMFolJUjvqibFOcS4St4Y8egX1leh6h9PoXkARnkfwVsU+fKUikow/dnDs+7QUoTxw+FpEyzJginxJwevrm7FiJ1Bwealw//2Jz2EA5/pTwcUrwFnhFB9uVtTJ4UDs+eXXan+9eA4sgwzJyU0Kyv/C4Fk7Wt/BhjCsM58w== Original-Received: from VI1EUR06FT039.eop-eur06.prod.protection.outlook.com (2a01:111:e400:fc37::42) by VI1EUR06HT200.eop-eur06.prod.protection.outlook.com (2a01:111:e400:fc37::505) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4457.17; Fri, 27 Aug 2021 03:25:32 +0000 Original-Received: from DB7P192MB0313.EURP192.PROD.OUTLOOK.COM (2a01:111:e400:fc37::41) by VI1EUR06FT039.mail.protection.outlook.com (2a01:111:e400:fc37::128) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4457.17 via Frontend Transport; Fri, 27 Aug 2021 03:25:32 +0000 X-IncomingTopHeaderMarker: OriginalChecksum:8842A9430213B0987C7ADFA51C28C5D5F357AA45B2E7FB2CCBF94FE96B955819; UpperCasedChecksum:7F4ECC1C2AF10B17E6E601FE2A5D9C609FA4FBCBE6903C6903492CB5BEDFBC19; SizeAsReceived:8590; Count:44 Original-Received: from DB7P192MB0313.EURP192.PROD.OUTLOOK.COM ([fe80::7de8:294a:77d:2cc2]) by DB7P192MB0313.EURP192.PROD.OUTLOOK.COM ([fe80::7de8:294a:77d:2cc2%4]) with mapi id 15.20.4457.018; Fri, 27 Aug 2021 03:25:19 +0000 X-TMN: [2gJAOjibY0lpOb87a5HEKYiA5BFcKByc] X-ClientProxiedBy: BL1PR13CA0116.namprd13.prod.outlook.com (2603:10b6:208:2b9::31) To DB7P192MB0313.EURP192.PROD.OUTLOOK.COM (2603:10a6:5:3::12) X-Microsoft-Original-Message-ID: <7eb130d7-f511-5ffa-5a54-f1a8b17fd1b5@live.com> X-MS-Exchange-MessageSentRepresentingType: 1 Original-Received: from [192.168.1.15] (24.61.240.80) by BL1PR13CA0116.namprd13.prod.outlook.com (2603:10b6:208:2b9::31) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4478.10 via Frontend Transport; Fri, 27 Aug 2021 03:25:18 +0000 X-MS-PublicTrafficType: Email X-IncomingHeaderCount: 44 X-EOPAttributedMessage: 0 X-MS-Office365-Filtering-Correlation-Id: ec195c35-7875-4707-6c85-08d9690a4bb7 X-MS-TrafficTypeDiagnostic: VI1EUR06HT200: X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: nP4n2mzkyZb2EV7ktH5oX8Ttv75UFl4KAfk16fAlj55JfRBZjalh9FaebJuYl/BuRYsbYdyQ0PTT7YWXbnyP5vDEKFjwyR8rSrYThPHwqZdc6HiO6Pr5Ai5k0zxTEgoGIHh45G7fZzhhUxnLJr9iU4cWufvMp9xn+Ii1iXfkxCSIBON88bEgQRCeHUocZmQMLaXMtUp7OE8mMMqU9sXW7vWSF7OcJmnJSfnUwvmqq1o2ziN73OrCVtYAVb6YC1vCoGV4M5vlubj3g/X0hjlqi9Aurio2W5hwMVXq0itsNEZzrhpYUK9ScwEyMTQ3WMyCDmF5bTZ+PEAxVAcBmXHASO+Q+zrB/H13J7SlARrEQJP4YGwAAodqkY9OyNcw5Tnf+hDLAap4HlO7P2LkqOOHXYvUmWuXbDV0Us74TqubeyRbtNEwB1GjWFKZDrwb+uzr X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: 3doVcFjJbIcStTSILEGccBBAkdKhK2odE/17SjNCem/WXn5AUWlJZqol9y0d/dGHxvuw6rMwcMwy0G6g7V373QKv4F+R7bp3Y0yIpmOgKIS9TnLIel7oYnW0+2T89aPJR4JpmLb7MoG+zchoTo2Mhg== X-OriginatorOrg: live.com X-MS-Exchange-CrossTenant-Network-Message-Id: ec195c35-7875-4707-6c85-08d9690a4bb7 X-MS-Exchange-CrossTenant-OriginalArrivalTime: 27 Aug 2021 03:25:19.6963 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa X-MS-Exchange-CrossTenant-AuthSource: VI1EUR06FT039.eop-eur06.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: Internet X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1EUR06HT200 Received-SPF: pass client-ip=2a01:111:f400:fe11::826; envelope-from=clement.pitclaudel@live.com; helo=EUR06-VI1-obe.outbound.protection.outlook.com X-Spam_score_int: 2 X-Spam_score: 0.2 X-Spam_bar: / X-Spam_report: (0.2 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FORGED_MUA_MOZILLA=2.309, FREEMAIL_FROM=0.001, MSGID_FROM_MTA_HEADER=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action 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:212785 Archived-At: --p7XXc5PqLnPeEg5sg5t64O4i1u931Iv94 Content-Type: multipart/mixed; boundary="7XWa7F0Juwsq3yYVWPBcWnSeviB6fBEh2"; protected-headers="v1" From: =?UTF-8?Q?Cl=c3=a9ment_Pit-Claudel?= To: bug-gnu-emacs Message-ID: <7eb130d7-f511-5ffa-5a54-f1a8b17fd1b5@live.com> Subject: Advising a function pollutes its docstring --7XWa7F0Juwsq3yYVWPBcWnSeviB6fBEh2 Content-Type: text/plain; charset=utf-8 Content-Language: en-GB Content-Transfer-Encoding: quoted-printable Hi all, Advising a function changes the first line of its docstring, which breaks= packages that use the first line of the docstring to display a short pie= ce of information about a function. I noticed this issue while playing w= ith the "shortdoc" feature. For example: M-x shortdoc-display-group RET process: (make-process &rest args) Start a program in a subprocess. Return the process object for it. (make-process :name "foo" :command '("cat" "/tmp/foo")) But after running (advice-add 'make-process :before (lambda (&rest args))= ): (make-process &rest args) This function has :before advice: No documentation (make-process :name "foo" :command '("cat" "/tmp/foo")) eg. =E2=87=92 # It would be nice to place the bit of text about advice somewhere else =E2= =80=94 maybe with the indented paragraph of the docs that says when the f= unction was introduced and which group contains the relevant docs? (make-process &rest ARGS) Other relevant functions are documented in the process group. Probably introduced at or before Emacs version 25.1. // HERE? // This function has :before advice: No documentation Start a program in a subprocess. Return the process object for it. Cl=C3=A9ment. --7XWa7F0Juwsq3yYVWPBcWnSeviB6fBEh2-- --p7XXc5PqLnPeEg5sg5t64O4i1u931Iv94 Content-Type: application/pgp-signature; name="OpenPGP_signature.asc" Content-Description: OpenPGP digital signature Content-Disposition: attachment; filename="OpenPGP_signature" -----BEGIN PGP SIGNATURE----- wsF5BAABCAAjFiEElGa8adIcPra4Jxxu+qD5xOb3TCMFAmEoWxsFAwAAAAAACgkQ+qD5xOb3TCN3 FRAAm2lYITEZW+IwN6E6BNhNGm65G24RrruzuKf2ah0kolzp8Faa70i0BD6JLLR9/I2NPOuZWPoU BL30dHnGabj52YY/Wwlvgzy9WlIguviClL7MPZSz3xmux7j3G+YwCuB2+N4cJmb4tz33hKPAxKpF tEYX8yXYiaJJVgFgfnr6Bx526HhZ/DXLAdYH1ejkvNJHyyin+WGYiLVKyZ1hoOjFczY3EhUDGe2G iVxOlEJ3d8DmEdf3KsQC86sEYEREUc6e7c90V8ILlLnpM4shXuMep9/uXylaVN7V8xOcE5Ky4UFc PzekyCB6+SuFK3QuwA/g1JaZ+2JQQN1vYQUuh+lJZHD4iBe/MrKSxNvFn89E7zlLQrVVgCHduBts es5bNp6KXowT0Nam8uUar89bUQJ5JeTSKk4VK0fLcJN1mbO+VTyCQB9IOcDzohR2yuTWqORmJT3A LQmzbF6MoP+VAp36VvHUQwp+prZ9+8BDdrbFhd4U/yet8k2K+7+nvG1jn9DSxl9+AFAQWz89iG/D PjWWja+9Ft1lNbfdPg+f02wQW9jzE5xbQicvcDVU7jD01/Gl2qMwSdEkGC5X2b5jj+UmK6LhkZzi k9FGuv4QHH0FN62jl7c5TPF8x3krNzK08HrX+zJipu51YLmn5kXL4lzhEKDSqg139/ggvwUK9xGI zAM= =AX30 -----END PGP SIGNATURE----- --p7XXc5PqLnPeEg5sg5t64O4i1u931Iv94--