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, 31 Dec 2020 05:42:16 +0100 Message-ID: <87bleaoac7.fsf@gnus.org> References: <87zh34wfxo.fsf@gnus.org> <87v9dss2ic.fsf@gnus.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="20678"; 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 Dec 31 05:43:15 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 1kupnu-0005In-AX for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 31 Dec 2020 05:43:14 +0100 Original-Received: from localhost ([::1]:32912 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kupnt-0007Hr-DX for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 30 Dec 2020 23:43:13 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:49924) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kupni-0007Ha-Pl for bug-gnu-emacs@gnu.org; Wed, 30 Dec 2020 23:43:02 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:40118) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kupni-0005yi-Hg for bug-gnu-emacs@gnu.org; Wed, 30 Dec 2020 23:43:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1kupni-0005Um-En for bug-gnu-emacs@gnu.org; Wed, 30 Dec 2020 23:43:02 -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, 31 Dec 2020 04:43:02 +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.160938974921085 (code B ref 44858); Thu, 31 Dec 2020 04:43:02 +0000 Original-Received: (at 44858) by debbugs.gnu.org; 31 Dec 2020 04:42:29 +0000 Original-Received: from localhost ([127.0.0.1]:51664 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kupnB-0005U0-0z for submit@debbugs.gnu.org; Wed, 30 Dec 2020 23:42:29 -0500 Original-Received: from quimby.gnus.org ([95.216.78.240]:44346) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kupn9-0005To-Qi for 44858@debbugs.gnu.org; Wed, 30 Dec 2020 23:42:28 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org; s=20200322; h=Content-Transfer-Encoding:Content-Type:MIME-Version:Message-ID :In-Reply-To:Date:References:Subject:Cc:To:From:Sender:Reply-To: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=bnStziDB9qfaCy+V+JB2WXSBsso7cyjOI3/yQyAe7QM=; b=QfTSsU+hesmRSjzIwCmtqwLjkb 7v7tdRj3oLJEftwc5UCLKl2NkEfPako6U782o4h0N4f38WUm8aCHT6K1QzCx+g9w/mN+TkskGSoAD um0+OxSeCovSy2s1J5f1pp/U40wL+KtJovVuoWxpMSKGI8QaG7FmWesxvvIUoduaaIz0=; 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 1kupn0-0002FM-At; Thu, 31 Dec 2020 05:42:21 +0100 Face: iVBORw0KGgoAAAANSUhEUgAAADAAAAAwBAMAAAClLOS0AAAABGdBTUEAALGPC/xhBQAAACBj SFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAGFBMVEUEAQIvFRxjJjBu OEeVKzm6SVTUja3///9ttdmYAAAAAWJLR0QHFmGI6wAAAAd0SU1FB+QMHwQdC+M8RLQAAAGwSURB VDjLvdNdcpswEAdwyekBWJIDgCDvDSIHsLzKe1utboDuf4TufyG20xnPtC9dj7HNj/2QwM79zyDv ibp/gb+Oh8kP6xLiIdyS/PVrQIw2bmfX/QnejhRGfwfT0vl+CovzfVzoClOMifo+Rh5OwYCODOZL mPTISx85jscSDDjMOKaehQfnJojCrKdWPc+XPguP5KPBSKjFFpPCG/n3MQC6nnPZIWbJZ/I1TAPA z3JAUkh0qkt8A9AVLlkkjTdAT+as71W2RE81ymKldsB7zfKTnmusi0uBDqgoluWHwnuNCqELWZvk K7xUadGx7mp4Fcm1YgIx2NovhTnNOkxurVjGWaEB0oyfBoX1ddYerW0Kdl0tClLKyt+p38H2Q1qp m34CPKABBCAZkCYe7kCktg0js97KjugTmkHBuLrd7oAZUABYfRicp73UC/O2Axauj5CnyeAbVnsP p2k1OCnkIgcohXkHD9gU+DNmbgCHUl9gzTtgrE3qDRiwOR0LIHeAFsVp94w68jWBAWx17FFFfCBB weOagl1iuwUATXfozgD76wQDlHXoHj4O0KcVgLzf7ojGH+OStcgAAAAldEVYdGRhdGU6Y3JlYXRl ADIwMjAtMTItMzFUMDQ6Mjk6MTArMDA6MDBI12lTAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDIwLTEy LTMxVDA0OjI5OjEwKzAwOjAwOYrR7wAAAABJRU5ErkJggg== X-Now-Playing: The Cure's _Pornography (1)_: "The Figurehead" In-Reply-To: (Stefan Kangas's message of "Wed, 30 Dec 2020 04:07:14 -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:197063 Archived-At: Stefan Kangas writes: > But this line has to be like this if `C-h f' is to show anything but > (&rest spec) for the function parameters. So should we just add some > special case where we ignore the last line if it matches "^([^)])$"? Sounds reasonable. > > 2. cl-defstruct > > In epg-context--make: > epg.el:197:30: Warning: docstring wider than 80 characters > > Here I can't figure out why the docstring is too long. Using > `macrostep-expand' doesn't reveal why. Does anyone have any ideas? Hm. The doc string (as displayed by the help functions) is: epg-context--make is a compiled Lisp function in =E2=80=98epg.el=E2=80=99. (epg-context--make PROTOCOL &optional ARMOR TEXTMODE INCLUDE-CERTS CIPHER-ALGORITHM DIGEST-ALGORITHM COMPRESS-ALGORITHM) This function does not change global state, including the match data. Constructor for objects of type =E2=80=98epg-context=E2=80=99. Has that been folded at some point after your function has looked at it? > 3. defclass > > These are autogenerated docstrings that I don't trivially see how we can > just wrap as it's the first line that is too long: > > In jsonrpc-request: > jsonrpc.el:349:15: Warning: docstring wider than 80 characters > > In toplevel form: > cedet/ede/proj-comp.el:71:26: Warning: docstring wider than 80 characters > > I suppose we need to rethink these, somehow. These bits can be filled: Specialized Methods: =E2=80=98jsonrpc--next-request-id=E2=80=99 ((this jsonrpc-connection)) Retrieve the slot =E2=80=98-next-request-id=E2=80=99 from an object of clas= s =E2=80=98jsonrpc-connection=E2=80=99. These bits: Instance Allocated Slots: Name Type Default Doc =E2=80=94=E2=80=94=E2=80=94=E2=80=94 =E2=80=94=E2=80=94=E2=80=94=E2=80=94 = =E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94=E2=80=94 =E2=80=94= =E2=80=94=E2=80=94 name t unbound A name for the connection -request-dispatcher t #'ignore Dispatcher for remotely invoked requests. -notification-dispatcher t #'ignore Dispatc Have to be reformatted -- just moving the Doc to the next line should be sufficient for most things. --=20 (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no