From unknown Tue Jun 24 07:00:18 2025 X-Loop: help-debbugs@gnu.org Subject: bug#65790: 29.1; "docstring wider than 80 characters" when there is no docstring Resent-From: Damien Cassou Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 06 Sep 2023 19:10:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 65790 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: 65790@debbugs.gnu.org X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.169402734730280 (code B ref -1); Wed, 06 Sep 2023 19:10:01 +0000 Received: (at submit) by debbugs.gnu.org; 6 Sep 2023 19:09:07 +0000 Received: from localhost ([127.0.0.1]:37737 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qdxti-0007sK-Pm for submit@debbugs.gnu.org; Wed, 06 Sep 2023 15:09:07 -0400 Received: from lists.gnu.org ([2001:470:142::17]:45026) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qdxtf-0007rk-Ii for submit@debbugs.gnu.org; Wed, 06 Sep 2023 15:09:05 -0400 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 1qdxtN-00032Z-8p for bug-gnu-emacs@gnu.org; Wed, 06 Sep 2023 15:08:49 -0400 Received: from mail.choca.pics ([80.67.172.235]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qdxtJ-0001I6-RN for bug-gnu-emacs@gnu.org; Wed, 06 Sep 2023 15:08:44 -0400 Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id E885218192DDD for ; Wed, 6 Sep 2023 21:08:30 +0200 (CEST) Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavis, port 10032) with ESMTP id XorZjzIm4012 for ; Wed, 6 Sep 2023 21:08:30 +0200 (CEST) Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 820CF18192DE4 for ; Wed, 6 Sep 2023 21:08:30 +0200 (CEST) X-Virus-Scanned: amavis at choca.pics Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavis, port 10026) with ESMTP id lPNNYqRNwAvO for ; Wed, 6 Sep 2023 21:08:30 +0200 (CEST) Received: from localhost (91.60.75.86.rev.sfr.net [86.75.60.91]) by mail.choca.pics (Postfix) with ESMTPSA id 28DFA18192DDD for ; Wed, 6 Sep 2023 21:08:30 +0200 (CEST) From: Damien Cassou Date: Wed, 06 Sep 2023 21:08:29 +0200 Message-ID: <87edjbp1aq.fsf@cassou.me> MIME-Version: 1.0 Content-Type: text/plain Received-SPF: pass client-ip=80.67.172.235; envelope-from=damien@cassou.me; helo=mail.choca.pics 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_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: 0.9 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.1 (/) I have this piece of code: (cl-defstruct (json-process-client-application (:constructor json-process-client--application-create) (:conc-name json-process-client--application-)) message-callbacks) In GNU Emacs 29.1, "Warning: docstring wider than 80 characters" even though I wrote no docstring here. I understand the problem lies in the generated code and I agree the lisp names in my code are long. But, I don't think the byte compiler should annoy me about docstrings I didn't write. What do you think? -- Damien Cassou "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill From unknown Tue Jun 24 07:00:18 2025 X-Loop: help-debbugs@gnu.org Subject: bug#65790: 29.1; "docstring wider than 80 characters" when there is no docstring Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 07 Sep 2023 05:05:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 65790 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: Damien Cassou Cc: 65790@debbugs.gnu.org Received: via spool by 65790-submit@debbugs.gnu.org id=B65790.169406309410791 (code B ref 65790); Thu, 07 Sep 2023 05:05:02 +0000 Received: (at 65790) by debbugs.gnu.org; 7 Sep 2023 05:04:54 +0000 Received: from localhost ([127.0.0.1]:38299 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qe7CH-0002nz-W4 for submit@debbugs.gnu.org; Thu, 07 Sep 2023 01:04:54 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:42756) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qe7CD-0002nk-SA for 65790@debbugs.gnu.org; Thu, 07 Sep 2023 01:04:52 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qe7C5-0007Bp-SO; Thu, 07 Sep 2023 01:04:41 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=Q0X5wvLmjYsLznaBb1iDSWW2uRsZcfEKtGwYfOGgJ3o=; b=jAx+IGjwIrkV 3SjPYOXiPlg1Jc56xfDf3RkxAYOYiF+9OwSwVl/bydkzgY1EimpI94wMoY1q3cQbWJCa29wgU3Trx te5umkZGdLXxSMf221NSpmvJc64HObMmL3jSCwkJM2X65QnWboJbU2R2av14AejPaqQgifO4W7SVe N//AYFZCQX+FC0Fw0hE1Nw8xnTgg35gWDh7VjLuL/YvoJpFfIulDSLACEUIu09DCevJpM3YECQJoT 12ujo05cNDlbUJOkk8H0iT/XaVJHPzrS0esdvT0HXRKRd3mpgjBolouXKXCCBYUoaUGsb3vOz3Bxo pTgFwxX/0+PNTX1EwnhbGg==; Date: Thu, 07 Sep 2023 08:04:28 +0300 Message-Id: <83a5ty1smb.fsf@gnu.org> From: Eli Zaretskii In-Reply-To: <87edjbp1aq.fsf@cassou.me> (message from Damien Cassou on Wed, 06 Sep 2023 21:08:29 +0200) References: <87edjbp1aq.fsf@cassou.me> X-Spam-Score: -2.3 (--) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > From: Damien Cassou > Date: Wed, 06 Sep 2023 21:08:29 +0200 > > I have this piece of code: > > (cl-defstruct (json-process-client-application > (:constructor json-process-client--application-create) > (:conc-name json-process-client--application-)) > message-callbacks) > > In GNU Emacs 29.1, "Warning: docstring wider than 80 characters" even > though I wrote no docstring here. I understand the problem lies in the > generated code and I agree the lisp names in my code are long. But, I > don't think the byte compiler should annoy me about docstrings I didn't > write. > > What do you think? How else will we/you know there's a potential problem there? If you think you can do nothing about this problem, just ignore the warning. It's just a warning. From unknown Tue Jun 24 07:00:18 2025 X-Loop: help-debbugs@gnu.org Subject: bug#65790: 29.1; "docstring wider than 80 characters" when there is no docstring Resent-From: Stefan Kangas Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 07 Sep 2023 08:53:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 65790 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: Damien Cassou , 65790@debbugs.gnu.org Received: via spool by 65790-submit@debbugs.gnu.org id=B65790.16940767381076 (code B ref 65790); Thu, 07 Sep 2023 08:53:01 +0000 Received: (at 65790) by debbugs.gnu.org; 7 Sep 2023 08:52:18 +0000 Received: from localhost ([127.0.0.1]:38545 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qeAkJ-0000HF-BX for submit@debbugs.gnu.org; Thu, 07 Sep 2023 04:52:17 -0400 Received: from mail-lf1-x136.google.com ([2a00:1450:4864:20::136]:53409) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qeAkD-0000Gw-3q for 65790@debbugs.gnu.org; Thu, 07 Sep 2023 04:52:13 -0400 Received: by mail-lf1-x136.google.com with SMTP id 2adb3069b0e04-500cfb168c6so1117100e87.2 for <65790@debbugs.gnu.org>; Thu, 07 Sep 2023 01:52:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1694076721; x=1694681521; darn=debbugs.gnu.org; h=to:subject:message-id:date:mime-version:references:in-reply-to:from :from:to:cc:subject:date:message-id:reply-to; bh=cDe4H8mBkR7lmqirAjqyT5Il/HAzIXL93RzZEY1r62U=; b=aOs+gBpgOOyo6JYOheEnn0ir2uLu3nE67QH9aC9rckxb/m/Cn20c5ZXP2jVx/HGLmX 8UFtOgMHLkheyDRDnyDLcG6ybrD2mKiICktGubJs/1kJ3hkpGeLLSAFj8qbBQa2tBlg9 x3A0tvnyVtLxjivhjUsYOoVycyJ/3SrwAPYX8LNyDmnz+3GAXp1y7G2CqQt9v6iZgmCM nMNoa8wAji97WdcpdDmcab27L66YaCwIzi1OMZ8AfE45wJH7tP3cvYgIDzGjKYcqNabg bD20Qt1CfnFGgZ2T+fQ6Sc1qfFnKYXDvb0VjlEpVDLOPCFGGqWpJ5mdvFbxpDVlrndeg jFlQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1694076721; x=1694681521; h=to:subject:message-id:date:mime-version:references:in-reply-to:from :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=cDe4H8mBkR7lmqirAjqyT5Il/HAzIXL93RzZEY1r62U=; b=TQB/9GQPGIzvCg3uH1BTehyYBOBCwQM2d0WdVxakCfwSHhM0CK9H0zQiJEIbC1NUfc Kea7OPPcyvhS/gXA/ePHYlhaWYw2UNCfQ8zSt8725KdfadisppzG1RVKBhng8cZ49VTh m9ejQXm8SX9sMU55nFCoSEpn2JAHuxvptBnkM+LIvbkrRY+f0se67b5xmy5mzjFlWvql +tSg9I8kx8YI/klQKJFuYXdQdP7ISminzUNyh0FMx4Bu+L4XaYbYwD3cE1ueQwSjRgOa 7a0TKvApQqYxqeDsuFkt+U/wFZ+FtjuZBId8ukTZPm5jE9CBKfIlP6aVlz+eNehLq83h mmRw== X-Gm-Message-State: AOJu0YyBNf9be+0R5470fMn946DIUM1pWKQZVYf45VgKpa+XuT3SVwJp My5W6U911Ou8ZRBOGyDOKyIxHzmgmcBvePZM3Sh3oUw4tVU= X-Google-Smtp-Source: AGHT+IHbMIfzjbE+gZlM4U3i/KCwwvzfeaaIodGG6w9gm0g7pGTh80oyxbrdvHlqrWoloJQHIAry5K5f5N2w333hK3E= X-Received: by 2002:a05:6512:20cb:b0:500:8ecb:509 with SMTP id u11-20020a05651220cb00b005008ecb0509mr3643711lfr.15.1694076721306; Thu, 07 Sep 2023 01:52:01 -0700 (PDT) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Thu, 7 Sep 2023 01:52:00 -0700 From: Stefan Kangas In-Reply-To: <87edjbp1aq.fsf@cassou.me> References: <87edjbp1aq.fsf@cassou.me> MIME-Version: 1.0 Date: Thu, 7 Sep 2023 01:52:00 -0700 Message-ID: Content-Type: text/plain; charset="UTF-8" X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Damien Cassou writes: > I have this piece of code: > > (cl-defstruct (json-process-client-application > (:constructor json-process-client--application-create) > (:conc-name json-process-client--application-)) > message-callbacks) > > In GNU Emacs 29.1, "Warning: docstring wider than 80 characters" even > though I wrote no docstring here. I understand the problem lies in the > generated code and I agree the lisp names in my code are long. But, I > don't think the byte compiler should annoy me about docstrings I didn't > write. > > What do you think? Yes, it would be nice not to get that warning. I fixed many such problems when I first added the warning about long docstrings. Patches welcome. PS. As a work-around, you can set `byte-compile-docstring-max-column'. From unknown Tue Jun 24 07:00:18 2025 X-Loop: help-debbugs@gnu.org Subject: bug#65790: 29.1; "docstring wider than 80 characters" when there is no docstring Resent-From: Damien Cassou Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 07 Sep 2023 09:31:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 65790 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: Eli Zaretskii Cc: 65790@debbugs.gnu.org Received: via spool by 65790-submit@debbugs.gnu.org id=B65790.169407901715149 (code B ref 65790); Thu, 07 Sep 2023 09:31:02 +0000 Received: (at 65790) by debbugs.gnu.org; 7 Sep 2023 09:30:17 +0000 Received: from localhost ([127.0.0.1]:38620 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qeBL7-0003wH-A0 for submit@debbugs.gnu.org; Thu, 07 Sep 2023 05:30:17 -0400 Received: from mail.choca.pics ([80.67.172.235]:42326) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qeBL5-0003w5-JX for 65790@debbugs.gnu.org; Thu, 07 Sep 2023 05:30:16 -0400 Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id F232018193F45; Thu, 7 Sep 2023 11:30:11 +0200 (CEST) Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavis, port 10032) with ESMTP id rYyl0_ltc_ag; Thu, 7 Sep 2023 11:30:11 +0200 (CEST) Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 5D03618193F48; Thu, 7 Sep 2023 11:30:11 +0200 (CEST) X-Virus-Scanned: amavis at choca.pics Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavis, port 10026) with ESMTP id Nthcx37KVImq; Thu, 7 Sep 2023 11:30:11 +0200 (CEST) Received: from localhost (unknown [IPv6:2001:41d0:fc22:6000:7f35:2bb3:a3e6:d73a]) by mail.choca.pics (Postfix) with ESMTPSA id AC1B818193F45; Thu, 7 Sep 2023 11:30:10 +0200 (CEST) From: Damien Cassou In-Reply-To: <83a5ty1smb.fsf@gnu.org> References: <87edjbp1aq.fsf@cassou.me> <83a5ty1smb.fsf@gnu.org> Date: Thu, 07 Sep 2023 11:30:10 +0200 Message-ID: <87il8mwct9.fsf@cassou.me> MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Hi Eli, Eli Zaretskii writes: > How else will we/you know there's a potential problem there? my opinion is that if more than 80 characters in a docstring is a problem then the macro should make sure not to generate one. > If you think you can do nothing about this problem, just ignore the > warning. It's just a warning. I hate warnings: either a problem is important and I want the build to fail or there is no problem and I don't want to see anything. If I let warnings exist then the ones I want to ignore will slowly be too numerous for me to notice those I would like to fix. This is why in my tool chain (makel) I'm always setting `byte-compile-error-on-warn' to t and I do similar things in non elisp-projects. This is just my opinion. Best -- Damien Cassou "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill From unknown Tue Jun 24 07:00:18 2025 X-Loop: help-debbugs@gnu.org Subject: bug#65790: 29.1; "docstring wider than 80 characters" when there is no docstring Resent-From: Damien Cassou Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 07 Sep 2023 09:34:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 65790 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: Stefan Kangas , 65790@debbugs.gnu.org Received: via spool by 65790-submit@debbugs.gnu.org id=B65790.169407918715398 (code B ref 65790); Thu, 07 Sep 2023 09:34:01 +0000 Received: (at 65790) by debbugs.gnu.org; 7 Sep 2023 09:33:07 +0000 Received: from localhost ([127.0.0.1]:38625 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qeBNq-00040I-Sf for submit@debbugs.gnu.org; Thu, 07 Sep 2023 05:33:07 -0400 Received: from mail.choca.pics ([80.67.172.235]:42396) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qeBNp-000409-7T for 65790@debbugs.gnu.org; Thu, 07 Sep 2023 05:33:05 -0400 Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id EA35918193F45; Thu, 7 Sep 2023 11:33:02 +0200 (CEST) Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavis, port 10032) with ESMTP id 12TDQkQGRpOO; Thu, 7 Sep 2023 11:33:02 +0200 (CEST) Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 612CB18193F48; Thu, 7 Sep 2023 11:33:02 +0200 (CEST) X-Virus-Scanned: amavis at choca.pics Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavis, port 10026) with ESMTP id yZgp_S8_CWCo; Thu, 7 Sep 2023 11:33:02 +0200 (CEST) Received: from localhost (unknown [IPv6:2001:41d0:fc22:6000:7f35:2bb3:a3e6:d73a]) by mail.choca.pics (Postfix) with ESMTPSA id E56D318193F45; Thu, 7 Sep 2023 11:33:01 +0200 (CEST) From: Damien Cassou In-Reply-To: References: <87edjbp1aq.fsf@cassou.me> Date: Thu, 07 Sep 2023 11:33:01 +0200 Message-ID: <87fs3qwcoi.fsf@cassou.me> MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Stefan Kangas writes: > Yes, it would be nice not to get that warning. I fixed many such > problems when I first added the warning about long docstrings. > > Patches welcome. The only patch I can think of would change the macro so that the docstring references each name on a line of its own. This way, we would only get a warning if the name itself is more than 80 characters. Would that be a reasonable patch for you? > PS. As a work-around, you can set `byte-compile-docstring-max-column'. Thank you for this. -- Damien Cassou "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill From unknown Tue Jun 24 07:00:18 2025 X-Loop: help-debbugs@gnu.org Subject: bug#65790: 29.1; "docstring wider than 80 characters" when there is no docstring Resent-From: Stefan Kangas Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 07 Sep 2023 09:48:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 65790 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: Damien Cassou , 65790@debbugs.gnu.org Received: via spool by 65790-submit@debbugs.gnu.org id=B65790.169408004116714 (code B ref 65790); Thu, 07 Sep 2023 09:48:01 +0000 Received: (at 65790) by debbugs.gnu.org; 7 Sep 2023 09:47:21 +0000 Received: from localhost ([127.0.0.1]:38652 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qeBbc-0004LW-SP for submit@debbugs.gnu.org; Thu, 07 Sep 2023 05:47:21 -0400 Received: from mail-lf1-x132.google.com ([2a00:1450:4864:20::132]:47428) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qeBba-0004LI-6d for 65790@debbugs.gnu.org; Thu, 07 Sep 2023 05:47:20 -0400 Received: by mail-lf1-x132.google.com with SMTP id 2adb3069b0e04-5008faf4456so1207068e87.3 for <65790@debbugs.gnu.org>; Thu, 07 Sep 2023 02:47:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1694080030; x=1694684830; darn=debbugs.gnu.org; h=to:subject:message-id:date:mime-version:references:in-reply-to:from :from:to:cc:subject:date:message-id:reply-to; bh=56AG8Rv6Zv443OvupohieviVQpAcyn0lSD5ewYd9Nqg=; b=YYv08yTdWStnZPdhmFwo5ZmdkaI/c9+XN5vj9tUMcxYJyLHP+5+vT3er5xf9XBdErM ruPR4iq9VTmbIj69t3zr9kmKYly6L7mbJbK4jIGDMC0Dw3VO01YeAa3XdE0e98Mlm867 USHfnIMgIofyQJYLzaA9qEw+pkd56PgCCejHH4VYlt03kYBtR7hMsc5KIGvB+UJUzINK mnJfSNQl3GxS8zyaew/ngBtQBIiPGOJ7hXX9imop4d2HhVWzJqbvgh7wdztmHi56u405 SO1pr0SgVHlYg9byqE0nH4/mgPU/BkBJAiCHayzKE3yf411sUJWLA39hPtGXwdKED/Lj Up0g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1694080030; x=1694684830; h=to:subject:message-id:date:mime-version:references:in-reply-to:from :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=56AG8Rv6Zv443OvupohieviVQpAcyn0lSD5ewYd9Nqg=; b=bhmPdINr9Zi75U5C+OUG6ys8kXP9QNUw52c4eBlwEiIgYKQGBmJu7jwPDa2VxYui0A OAS6tREsnPKB7znyCdvIj0O+/tbBF7sC4C43UykeCXefw+8Dxyez6yLHksalMwjJArKv HAJP7vOe415j/FYJ6nwUHkfWoWfMTZvAXsVafL5KsGbYarcrKnJ2o6jz1DApJpDQPvrz EBrnNQB7govW3fb06VPb2fufv0PniUeXTBZbMQ9n9c+HnbE4PirO5DWyGsWaUq3mAeYR G68BrWheWAl7ViKdXQy+U2nanrIVdKGkccScPWxb8SqelwZVPwi6cgGZPYjncTsAPzHb hRpg== X-Gm-Message-State: AOJu0YwLI8I1f+BhCT9DVW0gevjKrfdQ4RdH5TNfSS24Pb1yagKStbRw A5biO5R3ME8i0vCrjd4y6Pd7cqGz0IGdD95FDXo7rSzHmzM= X-Google-Smtp-Source: AGHT+IHqziqhKN68x25BZBKRG3HCJhxg+rMl8j/tdJhBtZL5eaogNwDdNuOdYSFx1GFTM/dloFBuKxh8Lm3AkWnYv4Q= X-Received: by 2002:a05:6512:6cf:b0:500:8fb1:7a47 with SMTP id u15-20020a05651206cf00b005008fb17a47mr1292485lff.30.1694080030417; Thu, 07 Sep 2023 02:47:10 -0700 (PDT) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Thu, 7 Sep 2023 02:47:09 -0700 From: Stefan Kangas In-Reply-To: <87fs3qwcoi.fsf@cassou.me> References: <87edjbp1aq.fsf@cassou.me> <87fs3qwcoi.fsf@cassou.me> MIME-Version: 1.0 Date: Thu, 7 Sep 2023 02:47:09 -0700 Message-ID: Content-Type: text/plain; charset="UTF-8" X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Damien Cassou writes: > The only patch I can think of would change the macro so that the > docstring references each name on a line of its own. This way, we would > only get a warning if the name itself is more than 80 characters. Would > that be a reasonable patch for you? That's basically the solution, yes, but we probably want to wrap the lines only when it's necessary. See `internal--fill-string-single-line' and where it is used for inspiration. From debbugs-submit-bounces@debbugs.gnu.org Fri Sep 08 12:47:28 2023 Received: (at control) by debbugs.gnu.org; 8 Sep 2023 16:47:28 +0000 Received: from localhost ([127.0.0.1]:45394 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qeedj-0001sb-PI for submit@debbugs.gnu.org; Fri, 08 Sep 2023 12:47:27 -0400 Received: from mail-lj1-x22d.google.com ([2a00:1450:4864:20::22d]:50443) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qeedg-0001sK-ON for control@debbugs.gnu.org; Fri, 08 Sep 2023 12:47:26 -0400 Received: by mail-lj1-x22d.google.com with SMTP id 38308e7fff4ca-2bcbfb3705dso37878931fa.1 for ; Fri, 08 Sep 2023 09:47:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1694191636; x=1694796436; darn=debbugs.gnu.org; h=to:subject:message-id:date:mime-version:from:from:to:cc:subject :date:message-id:reply-to; bh=2SY3vqNgzzq0zy655bm0+eKkv5bL5EQHmlU5XwRA7AM=; b=saC2fSb18dsQ2RWwMHGKsI37LzlRhw9kPoJEHo7SSsDGOPWpOkW78CKX8frpMYDEWt OrcYxe7PT0PH5XPtQ2hhaDF3Ny1ZUSBKNHsQ4KaLS4qkO8fXcJUzeQlN7IsZk+kYioM4 L4KXLdt8AuWnYvrI7i47KdaX0u9ENB3vAlJMJcIrAjsgI3+ESEelHXwOErM3VkaR2vYK wvoYn9F3JSR1bso70Iqxv0pQ7p/K93br7gHAxyVbBM2TS1rGW9GKxnlrZJ4gI6KGayce COJ7JFoNQAVFrrZ3rhbV3WZYpA836MmnyKSfHAfnLKB+k6RjOwtwOKC4+IciUWHIazVq q4Yw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1694191636; x=1694796436; h=to:subject:message-id:date:mime-version:from:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=2SY3vqNgzzq0zy655bm0+eKkv5bL5EQHmlU5XwRA7AM=; b=PMXMRGknBcNefWeG+ZV6J6PdXMViqHUeXtmnFA3NWj8ZU5dQKEclhu5Vi6Kl6kYOjJ bMIOXJkMceGkpqzr3m6q2zXiCF/GZPIVhNnCm8A6OvohSMpKmFSlut9VXNeiuFWDW8DA 1XyvVWVq/K1xWkq7pAfOBe6GDJReyj/u+TUyAbJDiPBd90nxH0gZe+KlNODXpKH8BOgj dTHt5XmJ96pEMGnFX5axLJ/ljV90Ch5NSDwipvvO5+z84Ql15sLL6rXjvGDPHbkuaw+1 OZ5lW3T8bZsAANq1A8TnqtFUAPxemAk9JIfztVgylF5hXxHgfvar5lXILfXkFGKqXila CjGg== X-Gm-Message-State: AOJu0YzF1VvztJcEK7gdca6AiCwLN+lURbVDZQasWt/Q0GSL6Xbns9Wu +hR7zX5qSAqDGoAh8kphTxInoS41wFh0c2ZC/6XU4N0v X-Google-Smtp-Source: AGHT+IGYKCy5S3+Zu++T4uj/vZ2cI+sSLeqmnJ02fE6sktY+/GN+viFNlRx1tObhmHiqlODYgowivCg+zLHbofdRQqM= X-Received: by 2002:a2e:87d6:0:b0:2b9:b27c:f727 with SMTP id v22-20020a2e87d6000000b002b9b27cf727mr2170374ljj.8.1694191636385; Fri, 08 Sep 2023 09:47:16 -0700 (PDT) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Fri, 8 Sep 2023 09:47:16 -0700 From: Stefan Kangas MIME-Version: 1.0 Date: Fri, 8 Sep 2023 09:47:16 -0700 Message-ID: Subject: control message for bug #65790 To: control@debbugs.gnu.org Content-Type: text/plain; charset="UTF-8" X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) severity 65790 minor quit From unknown Tue Jun 24 07:00:18 2025 X-Loop: help-debbugs@gnu.org Subject: bug#65790: 29.1; "docstring wider than 80 characters" when there is no docstring Resent-From: Damien Cassou Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 10 Sep 2023 06:48:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 65790 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: Stefan Kangas , 65790@debbugs.gnu.org Received: via spool by 65790-submit@debbugs.gnu.org id=B65790.169432848110993 (code B ref 65790); Sun, 10 Sep 2023 06:48:02 +0000 Received: (at 65790) by debbugs.gnu.org; 10 Sep 2023 06:48:01 +0000 Received: from localhost ([127.0.0.1]:48855 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qfEEi-0002rC-I1 for submit@debbugs.gnu.org; Sun, 10 Sep 2023 02:48:00 -0400 Received: from mail.choca.pics ([2001:910:1410:500::1]:36154) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qfEEc-0002qK-UB for 65790@debbugs.gnu.org; Sun, 10 Sep 2023 02:47:59 -0400 Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 41A2A18192DF4; Sun, 10 Sep 2023 08:47:48 +0200 (CEST) Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavis, port 10032) with ESMTP id UCaUrIqgnt-s; Sun, 10 Sep 2023 08:47:47 +0200 (CEST) Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 85D5318192DF5; Sun, 10 Sep 2023 08:47:47 +0200 (CEST) X-Virus-Scanned: amavis at choca.pics Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavis, port 10026) with ESMTP id E5FYTUJrb81D; Sun, 10 Sep 2023 08:47:47 +0200 (CEST) Received: from localhost (91.60.75.86.rev.sfr.net [86.75.60.91]) by mail.choca.pics (Postfix) with ESMTPSA id 70F8518192DF4; Sun, 10 Sep 2023 08:47:46 +0200 (CEST) From: Damien Cassou In-Reply-To: References: <87edjbp1aq.fsf@cassou.me> <87fs3qwcoi.fsf@cassou.me> Date: Sun, 10 Sep 2023 08:47:42 +0200 Message-ID: <87o7iaikxd.fsf@cassou.me> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) --=-=-= Content-Type: text/plain Stefan Kangas writes: > That's basically the solution, yes, but we probably want to wrap the > lines only when it's necessary. See `internal--fill-string-single-line' > and where it is used for inspiration. What do you think about attached patch? The patch replaces one usage of `format' with `internal--format-docstring-line' and also slightly change 2 docstring texts. -- Damien Cassou "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-Shorten-docstrings-generated-in-cl-macs.el.patch >From 093c76caa8ac551868565d0e690b9979593cf94d Mon Sep 17 00:00:00 2001 From: Damien Cassou Date: Sun, 10 Sep 2023 08:40:52 +0200 Subject: [PATCH] Shorten docstrings generated in cl-macs.el * lisp/emacs-lisp/cl-macs.el (cl-defsubst): Reduce likelihood of "docstring wider than 80 characters" errors in generated code. --- lisp/emacs-lisp/cl-macs.el | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/lisp/emacs-lisp/cl-macs.el b/lisp/emacs-lisp/cl-macs.el index c8e2610c8b0..0f142b87e07 100644 --- a/lisp/emacs-lisp/cl-macs.el +++ b/lisp/emacs-lisp/cl-macs.el @@ -2931,7 +2931,15 @@ cl-defsubst ,(if (memq '&key args) `(&whole cl-whole &cl-quote ,@args) (cons '&cl-quote args)) - ,(format "compiler-macro for inlining `%s'." name) + ;; NB. This will produce incorrect results + ;; in some cases, as our coding conventions + ;; says that the first line must be a full + ;; sentence. However, if we don't word wrap + ;; we will have byte-compiler warnings about + ;; overly long docstrings. So we can't have + ;; a perfect result here, and choose to avoid + ;; the byte-compiler warnings. + ,(internal--format-docstring-line "compiler-macro for `%s'." name) (cl--defsubst-expand ',argns '(cl-block ,name ,@(cdr (macroexp-parse-body body))) nil @@ -3190,7 +3198,10 @@ cl-defstruct ;; a perfect result here, and choose to avoid ;; the byte-compiler warnings. (internal--format-docstring-line - "Access slot \"%s\" of `%s' struct CL-X." slot name) + "Access slot \"%s\" of CL-X." slot) + "\n" + (internal--format-docstring-line + "Struct CL-X is a `%s'." name) (if doc (concat "\n" doc) "")) (declare (side-effect-free t)) ,access-body) -- 2.41.0 --=-=-=-- From unknown Tue Jun 24 07:00:18 2025 X-Loop: help-debbugs@gnu.org Subject: bug#65790: 29.1; "docstring wider than 80 characters" when there is no docstring Resent-From: Stefan Kangas Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 10 Sep 2023 09:57:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 65790 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: Damien Cassou , 65790@debbugs.gnu.org Received: via spool by 65790-submit@debbugs.gnu.org id=B65790.169433977427965 (code B ref 65790); Sun, 10 Sep 2023 09:57:01 +0000 Received: (at 65790) by debbugs.gnu.org; 10 Sep 2023 09:56:14 +0000 Received: from localhost ([127.0.0.1]:49104 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qfHAs-0007Gz-76 for submit@debbugs.gnu.org; Sun, 10 Sep 2023 05:56:14 -0400 Received: from mail-lj1-x231.google.com ([2a00:1450:4864:20::231]:49229) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qfHAo-0007Gl-Gz for 65790@debbugs.gnu.org; Sun, 10 Sep 2023 05:56:12 -0400 Received: by mail-lj1-x231.google.com with SMTP id 38308e7fff4ca-2bcfd3220d3so56365801fa.2 for <65790@debbugs.gnu.org>; Sun, 10 Sep 2023 02:56:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1694339761; x=1694944561; darn=debbugs.gnu.org; h=to:subject:message-id:date:mime-version:references:in-reply-to:from :from:to:cc:subject:date:message-id:reply-to; bh=qRT+v7ooEnenUNWODtT/I9SB82gAmwww7DuLFj7o3R8=; b=kxRP6gzgNx9T7jazJQ3Y0bRzhl2r04FMUebqWXkgVF4sX7Oxcbp2afgRnyDzFXAfee rmVSI59ZM2iKssR9mLBhDvTP9DTB8PEv4iKpYs81g4pE0rWz27ySxdNtUjZxvDnEd4ax QZvw5xR441fhOHvwdjzHwzwFT8tQccuCbqMCelhCs44223wZBxQrvGUZb7oWsf/4V/KO iEJQI8kLBrO7zFHnHhGZ+kzqp75PZjyAEzyt7AV18KUC67Msxckh/rYJMsaKsqnaFCdv hbL0noB5f0iMsR7gdJhaI+qYSnmBVzdcAQYaY1ukqjLo0iQPnQiEsemllFAAYBHoDKAS /fzg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1694339761; x=1694944561; h=to:subject:message-id:date:mime-version:references:in-reply-to:from :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=qRT+v7ooEnenUNWODtT/I9SB82gAmwww7DuLFj7o3R8=; b=H+B2kIdtxV9AtUAx/rb+kUmlV38pmamXalQVNulVysFsUmHNrLd43/IbMz9h0RtxDT Yl1reiOi02VIM6pcCRUhS6H1hs4mzWgXWKWlteKLQfZp4KvfREqJPWrUslFsxGGVxEua 23Ne+furT3YtdSwxb40O1XP+JALtw1g3KnHPxdnUq+KsM/7mIORDthwa0bsTjKLuCBZK dzAGjoAs5onvfCaErWr6TkUgXLRGgT6RpdnuXO/HOLyuEx57BqdAnBhJXInJ/nAhXJYv Qaqr/MOFgh2wavb+HEONA38rny46f7MnVEDXPsc0lmV7JC5Np+lVMJnXcilUIHHoYi3S VI5A== X-Gm-Message-State: AOJu0Yw6Xm1I/xpN3aZXFl8+K719cjUe1nc9hOfFQwkwvt91kW9CM5y8 RJyPR5RvmY2j7QEbG6lv2ougdUBGFVdbl+BS1nI= X-Google-Smtp-Source: AGHT+IEk+cUVhzduBBsVtrb2YiWG02UN0Jdt7545Nj3cX7MalNVp7B5ojn179nNShlAfu02fYnqqaGHnl01UQTBkzgY= X-Received: by 2002:a2e:9093:0:b0:2bc:e470:1412 with SMTP id l19-20020a2e9093000000b002bce4701412mr5852050ljg.43.1694339760379; Sun, 10 Sep 2023 02:56:00 -0700 (PDT) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Sun, 10 Sep 2023 02:55:59 -0700 From: Stefan Kangas In-Reply-To: <87o7iaikxd.fsf@cassou.me> References: <87edjbp1aq.fsf@cassou.me> <87fs3qwcoi.fsf@cassou.me> <87o7iaikxd.fsf@cassou.me> MIME-Version: 1.0 Date: Sun, 10 Sep 2023 02:55:59 -0700 Message-ID: Content-Type: text/plain; charset="UTF-8" X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Damien Cassou writes: > What do you think about attached patch? The patch replaces one usage of > `format' with `internal--format-docstring-line' and also slightly change > 2 docstring texts. Thanks, some comments below. I think this also could use some tests, see bytecomp-tests.el:964 and onwards. > From 093c76caa8ac551868565d0e690b9979593cf94d Mon Sep 17 00:00:00 2001 > From: Damien Cassou > Date: Sun, 10 Sep 2023 08:40:52 +0200 > Subject: [PATCH] Shorten docstrings generated in cl-macs.el > > * lisp/emacs-lisp/cl-macs.el (cl-defsubst): Reduce likelihood of > "docstring wider than 80 characters" errors in generated code. Please remember to include the bug number when it is known. > --- > lisp/emacs-lisp/cl-macs.el | 15 +++++++++++++-- > 1 file changed, 13 insertions(+), 2 deletions(-) > > diff --git a/lisp/emacs-lisp/cl-macs.el b/lisp/emacs-lisp/cl-macs.el > index c8e2610c8b0..0f142b87e07 100644 > --- a/lisp/emacs-lisp/cl-macs.el > +++ b/lisp/emacs-lisp/cl-macs.el > @@ -2931,7 +2931,15 @@ cl-defsubst > ,(if (memq '&key args) > `(&whole cl-whole &cl-quote ,@args) > (cons '&cl-quote args)) > - ,(format "compiler-macro for inlining `%s'." name) > + ;; NB. This will produce incorrect results > + ;; in some cases, as our coding conventions > + ;; says that the first line must be a full > + ;; sentence. However, if we don't word wrap > + ;; we will have byte-compiler warnings about > + ;; overly long docstrings. So we can't have > + ;; a perfect result here, and choose to avoid > + ;; the byte-compiler warnings. > + ,(internal--format-docstring-line "compiler-macro for `%s'." name) Why drop the word "inlining"? (This comment might need reflowing.) > (cl--defsubst-expand > ',argns '(cl-block ,name ,@(cdr (macroexp-parse-body body))) > nil > @@ -3190,7 +3198,10 @@ cl-defstruct > ;; a perfect result here, and choose to avoid > ;; the byte-compiler warnings. > (internal--format-docstring-line > - "Access slot \"%s\" of `%s' struct CL-X." slot name) > + "Access slot \"%s\" of CL-X." slot) > + "\n" > + (internal--format-docstring-line > + "Struct CL-X is a `%s'." name) Could we keep the old format when possible, and use the new one only when needed? > (if doc (concat "\n" doc) "")) > (declare (side-effect-free t)) > ,access-body) > -- > 2.41.0 From unknown Tue Jun 24 07:00:18 2025 X-Loop: help-debbugs@gnu.org Subject: bug#65790: 29.1; "docstring wider than 80 characters" when there is no docstring Resent-From: Damien Cassou Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 12 Sep 2023 19:23:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 65790 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: Stefan Kangas , 65790@debbugs.gnu.org Received: via spool by 65790-submit@debbugs.gnu.org id=B65790.169454656124645 (code B ref 65790); Tue, 12 Sep 2023 19:23:01 +0000 Received: (at 65790) by debbugs.gnu.org; 12 Sep 2023 19:22:41 +0000 Received: from localhost ([127.0.0.1]:60102 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qg8y8-0006PQ-9o for submit@debbugs.gnu.org; Tue, 12 Sep 2023 15:22:41 -0400 Received: from mail.choca.pics ([2001:910:1410:500::1]:37344) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qg8y4-0006PD-VG for 65790@debbugs.gnu.org; Tue, 12 Sep 2023 15:22:38 -0400 Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id AAD0D18192DD8; Tue, 12 Sep 2023 21:22:28 +0200 (CEST) Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavis, port 10032) with ESMTP id pOX2uMwHNTB8; Tue, 12 Sep 2023 21:22:27 +0200 (CEST) Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 7F21B18192DF7; Tue, 12 Sep 2023 21:22:27 +0200 (CEST) X-Virus-Scanned: amavis at choca.pics Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavis, port 10026) with ESMTP id 8KMej7ZQcPYo; Tue, 12 Sep 2023 21:22:27 +0200 (CEST) Received: from localhost (91.60.75.86.rev.sfr.net [86.75.60.91]) by mail.choca.pics (Postfix) with ESMTPSA id F3FEC18192DD8; Tue, 12 Sep 2023 21:22:26 +0200 (CEST) From: Damien Cassou In-Reply-To: References: <87edjbp1aq.fsf@cassou.me> <87fs3qwcoi.fsf@cassou.me> <87o7iaikxd.fsf@cassou.me> Date: Tue, 12 Sep 2023 21:22:26 +0200 Message-ID: <87bke7nqml.fsf@cassou.me> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Thank you for your feedback. 3 patch files are attached to this email. My answers below: Stefan Kangas writes: > Damien Cassou writes: > I think this also could use some tests, see bytecomp-tests.el:964 and > onwards. I've added tests to bytecomp-tests.el as suggested. (why not cl-macs-tests.el instead?) >> * lisp/emacs-lisp/cl-macs.el (cl-defsubst): Reduce likelihood of >> "docstring wider than 80 characters" errors in generated code. > > Please remember to include the bug number when it is known. done >> - ,(format "compiler-macro for inlining `%s'." name) >> [=E2=80=A6] >> + ,(internal--format-docstring-line "compiler-macro for `%s'= ." name) > > Why drop the word "inlining"? I felt this word was not really important because (1) this is generated code and (2) the docstring starts with "compiler-macro". Removing it reduces the likelihood of the error message. I added an explanation in the commit message. If the word is important I can add it back. > (This comment might need reflowing.) done > Could we keep the old format when possible, and use the new one only > when needed? I tried to do that, is that what you want? I feel the added complexity isn't worth it so I'm fine changing it back to the simpler version if you change your mind. --=20 Damien Cassou "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-bytecomp-tests.el-Add-new-helper-function.patch >From 28c90e4c3371501f2965ff5aac0d5108572fa674 Mon Sep 17 00:00:00 2001 From: Damien Cassou Date: Mon, 11 Sep 2023 21:59:45 +0200 Subject: [PATCH 1/3] bytecomp-tests.el: Add new helper function * test/lisp/emacs-lisp/bytecomp-tests.el (bytecomp--without-warning-test): Add helper function. (bytecomp-warn--ignore): Use the helper. --- test/lisp/emacs-lisp/bytecomp-tests.el | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/test/lisp/emacs-lisp/bytecomp-tests.el b/test/lisp/emacs-lisp/bytecomp-tests.el index cd1bda3ec55..c0adab75269 100644 --- a/test/lisp/emacs-lisp/bytecomp-tests.el +++ b/test/lisp/emacs-lisp/bytecomp-tests.el @@ -937,14 +937,17 @@ bytecomp--with-warning-test (should (re-search-forward (string-replace " " "[ \n]+" re-warning))))))) +(defun bytecomp--without-warning-test (form) + (bytecomp--with-warning-test "\\`\\'" form)) + (ert-deftest bytecomp-warn--ignore () (bytecomp--with-warning-test "unused" '(lambda (y) 6)) - (bytecomp--with-warning-test "\\`\\'" ;No warning! + (bytecomp--without-warning-test '(lambda (y) (ignore y) 6)) (bytecomp--with-warning-test "assq" '(lambda (x y) (progn (assq x y) 5))) - (bytecomp--with-warning-test "\\`\\'" ;No warning! + (bytecomp--without-warning-test '(lambda (x y) (progn (ignore (assq x y)) 5)))) (ert-deftest bytecomp-warn-wrong-args () -- 2.41.0 --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0002-Shorten-docstrings-generated-by-cl-defsubst-bug-6579.patch >From 4be1620fe344ebacd707bfb6c69d34eaa1a27df5 Mon Sep 17 00:00:00 2001 From: Damien Cassou Date: Tue, 12 Sep 2023 08:28:37 +0200 Subject: [PATCH 2/3] Shorten docstrings generated by cl-defsubst (bug#65790) * lisp/emacs-lisp/cl-macs.el (cl-defsubst): Remove the word "inlining" in the generated docstring as it is not very useful and increases the likelihood of "docstring wider than 80 characters" errors. Additionally, split the first line of the docstring into 2 lines if the function name is very long. --- lisp/emacs-lisp/cl-macs.el | 9 ++++++++- test/lisp/emacs-lisp/bytecomp-tests.el | 11 +++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/lisp/emacs-lisp/cl-macs.el b/lisp/emacs-lisp/cl-macs.el index c8e2610c8b0..dc17f992660 100644 --- a/lisp/emacs-lisp/cl-macs.el +++ b/lisp/emacs-lisp/cl-macs.el @@ -2931,7 +2931,14 @@ cl-defsubst ,(if (memq '&key args) `(&whole cl-whole &cl-quote ,@args) (cons '&cl-quote args)) - ,(format "compiler-macro for inlining `%s'." name) + ;; NB. This will produce incorrect results in some + ;; cases, as our coding conventions says that the first + ;; line must be a full sentence. However, if we don't + ;; word wrap we will have byte-compiler warnings about + ;; overly long docstrings. So we can't have a perfect + ;; result here, and choose to avoid the byte-compiler + ;; warnings. + ,(internal--format-docstring-line "compiler-macro for `%s'." name) (cl--defsubst-expand ',argns '(cl-block ,name ,@(cdr (macroexp-parse-body body))) nil diff --git a/test/lisp/emacs-lisp/bytecomp-tests.el b/test/lisp/emacs-lisp/bytecomp-tests.el index c0adab75269..102616c9bb7 100644 --- a/test/lisp/emacs-lisp/bytecomp-tests.el +++ b/test/lisp/emacs-lisp/bytecomp-tests.el @@ -972,6 +972,17 @@ bytecomp-warn-wide-docstring/defvar (bytecomp--with-warning-test "defvar.*foo.*wider than.*characters" `(defvar foo t ,bytecomp-tests--docstring))) +(ert-deftest bytecomp-warn-wide-docstring/cl-defsubst () + (bytecomp--without-warning-test + `(cl-defsubst short-name () + "Do something.")) + (bytecomp--without-warning-test + `(cl-defsubst long-name-with-less-80-characters-but-still-quite-a-bit () + "Do something.")) + (bytecomp--with-warning-test "wider than.*characters" + `(cl-defsubst long-name-with-more-than-80-characters-yes-this-is-a-very-long-name-but-why-not!! () + "Do something."))) + (ert-deftest bytecomp-warn-quoted-condition () (bytecomp--with-warning-test "Warning: `condition-case' condition should not be quoted: 'arith-error" -- 2.41.0 --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0003-Shorten-docstrings-generated-by-cl-defstruct-bug-657.patch >From 23e8316ef7659b361157c0659bdb96a4bc9cb1e7 Mon Sep 17 00:00:00 2001 From: Damien Cassou Date: Tue, 12 Sep 2023 08:28:37 +0200 Subject: [PATCH 3/3] Shorten docstrings generated by cl-defstruct (bug#65790) * lisp/emacs-lisp/cl-macs.el (cl-defstruct): Split the first line of generated docstrings if either the struct name or a field name is very long. This reduces the likelihood of "docstring wider than 80 characters" errors. --- lisp/emacs-lisp/cl-macs.el | 44 ++++++++++++++++++-------- test/lisp/emacs-lisp/bytecomp-tests.el | 17 ++++++++++ 2 files changed, 48 insertions(+), 13 deletions(-) diff --git a/lisp/emacs-lisp/cl-macs.el b/lisp/emacs-lisp/cl-macs.el index dc17f992660..ef00f9e4fe4 100644 --- a/lisp/emacs-lisp/cl-macs.el +++ b/lisp/emacs-lisp/cl-macs.el @@ -3187,18 +3187,27 @@ cl-defstruct ;; The arg "cl-x" is referenced by name in e.g. pred-form ;; and pred-check, so changing it is not straightforward. (push `(,defsym ,accessor (cl-x) - ,(concat - ;; NB. This will produce incorrect results - ;; in some cases, as our coding conventions - ;; says that the first line must be a full - ;; sentence. However, if we don't word wrap - ;; we will have byte-compiler warnings about - ;; overly long docstrings. So we can't have - ;; a perfect result here, and choose to avoid - ;; the byte-compiler warnings. - (internal--format-docstring-line - "Access slot \"%s\" of `%s' struct CL-X." slot name) - (if doc (concat "\n" doc) "")) + ,(let ((long-docstring + (format "Access slot \"%s\" of `%s' struct CL-X." slot name))) + (concat + ;; NB. This will produce incorrect results + ;; in some cases, as our coding conventions + ;; says that the first line must be a full + ;; sentence. However, if we don't word + ;; wrap we will have byte-compiler warnings + ;; about overly long docstrings. So we + ;; can't have a perfect result here, and + ;; choose to avoid the byte-compiler + ;; warnings. + (if (>= (length long-docstring) byte-compile-docstring-max-column) + (concat + (internal--format-docstring-line + "Access slot \"%s\" of CL-X." slot) + "\n" + (internal--format-docstring-line + "Struct CL-X is a `%s'." name)) + (internal--format-docstring-line long-docstring)) + (if doc (concat "\n" doc) ""))) (declare (side-effect-free t)) ,access-body) forms) @@ -3274,7 +3283,16 @@ cl-defstruct (push `(,cldefsym ,cname (&cl-defs (nil ,@descs) ,@args) ,(if (stringp doc) doc - (format "Constructor for objects of type `%s'." name)) + ;; NB. This will produce incorrect results in + ;; some cases, as our coding conventions says that + ;; the first line must be a full sentence. + ;; However, if we don't word wrap we will have + ;; byte-compiler warnings about overly long + ;; docstrings. So we can't have a perfect result + ;; here, and choose to avoid the byte-compiler + ;; warnings. + (internal--format-docstring-line + "Constructor for objects of type `%s'." name)) ,@(if (cl--safe-expr-p `(progn ,@(mapcar #'cl-second descs))) '((declare (side-effect-free t)))) (,con-fun ,@make)) diff --git a/test/lisp/emacs-lisp/bytecomp-tests.el b/test/lisp/emacs-lisp/bytecomp-tests.el index 102616c9bb7..03aed5263b6 100644 --- a/test/lisp/emacs-lisp/bytecomp-tests.el +++ b/test/lisp/emacs-lisp/bytecomp-tests.el @@ -983,6 +983,23 @@ bytecomp-warn-wide-docstring/cl-defsubst `(cl-defsubst long-name-with-more-than-80-characters-yes-this-is-a-very-long-name-but-why-not!! () "Do something."))) +(ert-deftest bytecomp-warn-wide-docstring/cl-defstruct () + (bytecomp--without-warning-test + `(cl-defstruct short-name + field)) + (bytecomp--without-warning-test + `(cl-defstruct short-name + long-name-with-less-80-characters-but-still-quite-a-bit)) + (bytecomp--without-warning-test + `(cl-defstruct long-name-with-less-80-characters-but-still-quite-a-bit + field)) + (bytecomp--with-warning-test "wider than.*characters" + `(cl-defstruct short-name + long-name-with-more-than-80-characters-yes-this-is-a-very-long-name-but-why-not!!)) + (bytecomp--with-warning-test "wider than.*characters" + `(cl-defstruct long-name-with-more-than-80-characters-yes-this-is-a-very-long-name-but-why-not!! + field))) + (ert-deftest bytecomp-warn-quoted-condition () (bytecomp--with-warning-test "Warning: `condition-case' condition should not be quoted: 'arith-error" -- 2.41.0 --=-=-=-- From unknown Tue Jun 24 07:00:18 2025 MIME-Version: 1.0 X-Mailer: MIME-tools 5.505 (Entity 5.505) X-Loop: help-debbugs@gnu.org From: help-debbugs@gnu.org (GNU bug Tracking System) To: Damien Cassou Subject: bug#65790: closed (Re: bug#65790: 29.1; "docstring wider than 80 characters" when there is no docstring) Message-ID: References: <87edjbp1aq.fsf@cassou.me> X-Gnu-PR-Message: they-closed 65790 X-Gnu-PR-Package: emacs Reply-To: 65790@debbugs.gnu.org Date: Wed, 13 Sep 2023 14:39:02 +0000 Content-Type: multipart/mixed; boundary="----------=_1694615942-6601-1" This is a multi-part message in MIME format... ------------=_1694615942-6601-1 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Your bug report #65790: 29.1; "docstring wider than 80 characters" when there is no docstri= ng which was filed against the emacs package, has been closed. The explanation is attached below, along with your original report. If you require more details, please reply to 65790@debbugs.gnu.org. --=20 65790: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D65790 GNU Bug Tracking System Contact help-debbugs@gnu.org with problems ------------=_1694615942-6601-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at 65790-done) by debbugs.gnu.org; 13 Sep 2023 14:38:48 +0000 Received: from localhost ([127.0.0.1]:35563 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qgR0x-0001i4-Ms for submit@debbugs.gnu.org; Wed, 13 Sep 2023 10:38:47 -0400 Received: from mail-lj1-x22b.google.com ([2a00:1450:4864:20::22b]:58729) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qgR0s-0001hn-V6 for 65790-done@debbugs.gnu.org; Wed, 13 Sep 2023 10:38:46 -0400 Received: by mail-lj1-x22b.google.com with SMTP id 38308e7fff4ca-2bfbd7d49e7so9835751fa.1 for <65790-done@debbugs.gnu.org>; Wed, 13 Sep 2023 07:38:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1694615911; x=1695220711; darn=debbugs.gnu.org; h=to:subject:message-id:date:mime-version:references:in-reply-to:from :from:to:cc:subject:date:message-id:reply-to; bh=3CFRO+4g3TxW+fkbl78ZjfQYgvuZ1OpqdcvgowaAgD4=; b=lVxAp1MxTKEWDtvYy5aDM8kr+g0jPSCbnXJF5tIa8EuI5KSd2BrKc0Jfg+aVz5p89F fNu7CWWX0/WM8y7u2JhnDY5SyD7MLx7Dd4dioCjRAIdglG1RBFUcRlDxI6kQobHn/BEB H7VYd46RJf00P1ZWTY+qjAH3dw0L41LoYB/jN5wfqU8BxQTvyBlAVFtb7zTD2KY7lxRa TlENBFWUIOHyrOfJQK4FD6fxznTI2iFZp6ZsMKnWodOam/B0JJL1q4OKz/Qgi2nULRnG hLdGaPHztCbydgm1sD9ZTitwGYGmWlvGV+zNk8MTxRpuj5d9FdLMsVEoRzTlwK0vhIbi NW7w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1694615911; x=1695220711; h=to:subject:message-id:date:mime-version:references:in-reply-to:from :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=3CFRO+4g3TxW+fkbl78ZjfQYgvuZ1OpqdcvgowaAgD4=; b=oGHY5A5xMzHVYyBuUh6dBdbwGVRhk6cl2SH66mCcN+WQUxTHWUEBoLzNPCipO9X2F6 iwzkSiiEUXcUIRD7X5utzHZiKgCXHLqFTGPhFdFdRMZiLLtrdlyEljv3INZkxHkeHGvu 6wSwtSxTxWsiN+a67WfE5wzuTORjkLaTI3ys78MN8lsTuyM1VeDP1Or41ksM0AXp8m8F hXK8717TVdGs4za13aUuTsU5GFWOQ6LvhfUgMZJNIOybEmUbV+L1FRTDws0V5uFAKj1v eOilWQWLiqVZwc95TGXWlDD0ZR57cLMlr+0qcG0//U7O9abuzIsMoQIKrfjwSBNDaNqs yKcQ== X-Gm-Message-State: AOJu0YylUYmF4kNKp3vHKFP3AYs2VJX8d/xEUCwWY9k+QID13y+eWpSN SXq41p6701d45RUZpEcZNCnzgxoBEOZCdEExz4M= X-Google-Smtp-Source: AGHT+IH+FaePh2zftAmgPs92bgQ0eFsPnYmXVyQuUPoz3IeABTLUFSbTDK8yp9zA7cYMML2EJbDixAd9wZqY6IgaI2w= X-Received: by 2002:a2e:9dc5:0:b0:2bc:b557:cee9 with SMTP id x5-20020a2e9dc5000000b002bcb557cee9mr2684106ljj.43.1694615911438; Wed, 13 Sep 2023 07:38:31 -0700 (PDT) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Wed, 13 Sep 2023 07:38:31 -0700 From: Stefan Kangas In-Reply-To: <87bke7nqml.fsf@cassou.me> References: <87edjbp1aq.fsf@cassou.me> <87fs3qwcoi.fsf@cassou.me> <87o7iaikxd.fsf@cassou.me> <87bke7nqml.fsf@cassou.me> MIME-Version: 1.0 Date: Wed, 13 Sep 2023 07:38:31 -0700 Message-ID: Subject: Re: bug#65790: 29.1; "docstring wider than 80 characters" when there is no docstring To: Damien Cassou , 65790-done@debbugs.gnu.org Content-Type: text/plain; charset="UTF-8" X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 65790-done X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Version: 30.1 Damien Cassou writes: > I've added tests to bytecomp-tests.el as suggested. (why not > cl-macs-tests.el instead?) Good question. Perhaps we should move all of those tests to more relevant locations. OTOH, the macro for this is in bytecomp-tests.el currently, so I guess we'd have to move that. Maybe it would fit in ert-x.el. It seems outside the scope of this bug report though. >> Could we keep the old format when possible, and use the new one only >> when needed? > > I tried to do that, is that what you want? I feel the added complexity > isn't worth it so I'm fine changing it back to the simpler version if > you change your mind. The code is less nice obviously, but I think not changing the autogenerated docstrings in the typical cases is also important. Therefore, I think the complexity is ultimately worth it. Perhaps someone should do a round over all of this to see if it can be cleaned up a bit, though... I've now installed your patches on master. Feel free to post followups if you want to fix any of the above, or if you spot anything else that could be improved in relation to this. Thanks again for your efforts. ------------=_1694615942-6601-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at submit) by debbugs.gnu.org; 6 Sep 2023 19:09:07 +0000 Received: from localhost ([127.0.0.1]:37737 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qdxti-0007sK-Pm for submit@debbugs.gnu.org; Wed, 06 Sep 2023 15:09:07 -0400 Received: from lists.gnu.org ([2001:470:142::17]:45026) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qdxtf-0007rk-Ii for submit@debbugs.gnu.org; Wed, 06 Sep 2023 15:09:05 -0400 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 1qdxtN-00032Z-8p for bug-gnu-emacs@gnu.org; Wed, 06 Sep 2023 15:08:49 -0400 Received: from mail.choca.pics ([80.67.172.235]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qdxtJ-0001I6-RN for bug-gnu-emacs@gnu.org; Wed, 06 Sep 2023 15:08:44 -0400 Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id E885218192DDD for ; Wed, 6 Sep 2023 21:08:30 +0200 (CEST) Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavis, port 10032) with ESMTP id XorZjzIm4012 for ; Wed, 6 Sep 2023 21:08:30 +0200 (CEST) Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 820CF18192DE4 for ; Wed, 6 Sep 2023 21:08:30 +0200 (CEST) X-Virus-Scanned: amavis at choca.pics Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavis, port 10026) with ESMTP id lPNNYqRNwAvO for ; Wed, 6 Sep 2023 21:08:30 +0200 (CEST) Received: from localhost (91.60.75.86.rev.sfr.net [86.75.60.91]) by mail.choca.pics (Postfix) with ESMTPSA id 28DFA18192DDD for ; Wed, 6 Sep 2023 21:08:30 +0200 (CEST) From: Damien Cassou To: bug-gnu-emacs@gnu.org Subject: 29.1; "docstring wider than 80 characters" when there is no docstring Date: Wed, 06 Sep 2023 21:08:29 +0200 Message-ID: <87edjbp1aq.fsf@cassou.me> MIME-Version: 1.0 Content-Type: text/plain Received-SPF: pass client-ip=80.67.172.235; envelope-from=damien@cassou.me; helo=mail.choca.pics 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_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: 0.9 (/) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.1 (/) I have this piece of code: (cl-defstruct (json-process-client-application (:constructor json-process-client--application-create) (:conc-name json-process-client--application-)) message-callbacks) In GNU Emacs 29.1, "Warning: docstring wider than 80 characters" even though I wrote no docstring here. I understand the problem lies in the generated code and I agree the lisp names in my code are long. But, I don't think the byte compiler should annoy me about docstrings I didn't write. What do you think? -- Damien Cassou "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill ------------=_1694615942-6601-1--