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#44858: [PATCH] Make byte-compiler warn about wide docstrings Date: Thu, 26 Nov 2020 11:49:55 +0100 Message-ID: <87zh34wfxo.fsf@gnus.org> References: Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="14475"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: 44858@debbugs.gnu.org To: Stefan Kangas Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Nov 26 11:52:16 2020 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 1kiEsq-0003ez-0M for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 26 Nov 2020 11:52:16 +0100 Original-Received: from localhost ([::1]:45956 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kiEso-0002s8-UP for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 26 Nov 2020 05:52:14 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:53148) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kiErd-0002Kw-Td for bug-gnu-emacs@gnu.org; Thu, 26 Nov 2020 05:51:01 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:55312) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kiErd-0000Z6-L5 for bug-gnu-emacs@gnu.org; Thu, 26 Nov 2020 05:51:01 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1kiErd-0006BG-K8 for bug-gnu-emacs@gnu.org; Thu, 26 Nov 2020 05:51:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 26 Nov 2020 10:51:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 44858 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 44858-submit@debbugs.gnu.org id=B44858.160638781023695 (code B ref 44858); Thu, 26 Nov 2020 10:51:01 +0000 Original-Received: (at 44858) by debbugs.gnu.org; 26 Nov 2020 10:50:10 +0000 Original-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 1kiEqo-0006A6-D7 for submit@debbugs.gnu.org; Thu, 26 Nov 2020 05:50:10 -0500 Original-Received: from quimby.gnus.org ([95.216.78.240]:48444) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kiEqj-00069P-A4 for 44858@debbugs.gnu.org; Thu, 26 Nov 2020 05:50:09 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org; s=20200322; h=Content-Type:MIME-Version:Message-ID:In-Reply-To:Date: References:Subject:Cc:To:From:Sender:Reply-To:Content-Transfer-Encoding: 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=FLcdHNRQh5wn+cAcDD8OzwTaBtMK7kKQUk62fzq2jc0=; b=KqikdFCPr1L4p0vlPPdKQoSSIz UZIvN0ORx8Lw3dIuSBbhpWxRFL3juy6VwfJPFpILKa1i2kd3KBedl9F4v+hapzwtqoHDf5ty/r+Yl nSzckPQp0iBbsX9pMnyrmFStE5a4Q4VlgTLBwfH2SVEw1sQ4eOEkD3BnN6P5PbKLbDzo=; Original-Received: from cm-84.212.202.86.getinternet.no ([84.212.202.86] helo=xo) by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1kiEqa-0000SA-7u; Thu, 26 Nov 2020 11:49:58 +0100 X-Now-Playing: The Human League's _Dare_: "Seconds" In-Reply-To: (Stefan Kangas's message of "Tue, 24 Nov 2020 17:36:34 -0800") 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:194275 Archived-At: Stefan Kangas writes: > ** Make byte-compiler warn when a doc string is too wide > > Please find attached a patch that implements this. I like it. > Notably, it omits defuns, and ignores any lines containing > `substitute-command-keys' style substitutions. > > I've been messing around with getting defuns to work, but I can't find a > way for it to work reliably. The problem is that they are already macro > expanded when we start issuing warnings, so it's not trivial to reliably > separate defuns from other cases where lambda is used. I'm probably misunderstanding you completely, but do we have to separate between lambda and defuns? lambdas can also have doc strings... > (If you were to add defuns into the mix, we would get around 700 > warnings for wide docstrings, several of which would be autogenerated. > We should probably look into that at some point...) Yes, the autogenerated docstrings should be fixed, too -- mostly by running them through `fill-paragraph'. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no