From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Emanuel Berg Newsgroups: gmane.emacs.devel Subject: Re: Lisp files that load cl-lib in problematical ways Date: Mon, 23 Oct 2023 14:26:12 +0200 Message-ID: <87il6xmsnv.fsf@dataswamp.org> References: <835y38qvlg.fsf@gnu.org> <87bkcx6eci.fsf@dataswamp.org> <83ttqnm4ti.fsf@gnu.org> <87r0lqoo5x.fsf@dataswamp.org> <83msweu76j.fsf@gnu.org> <87o7gungi1.fsf@dataswamp.org> <83msw9o91l.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="25968"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) To: emacs-devel@gnu.org Cancel-Lock: sha1:zDfA+oSHFyebMcPdYQ/x6eBrgvs= Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Oct 23 14:45:44 2023 Return-path: Envelope-to: ged-emacs-devel@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 1quuJU-0006YZ-1S for ged-emacs-devel@m.gmane-mx.org; Mon, 23 Oct 2023 14:45:44 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1quuIx-0006J5-3t; Mon, 23 Oct 2023 08:45:13 -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 1quu0k-00044X-KR for emacs-devel@gnu.org; Mon, 23 Oct 2023 08:26:23 -0400 Original-Received: from ciao.gmane.io ([116.202.254.214]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1quu0i-0007Fs-VX for emacs-devel@gnu.org; Mon, 23 Oct 2023 08:26:22 -0400 Original-Received: from list by ciao.gmane.io with local (Exim 4.92) (envelope-from ) id 1quu0g-0000VC-Sp for emacs-devel@gnu.org; Mon, 23 Oct 2023 14:26:18 +0200 X-Injected-Via-Gmane: http://gmane.org/ Mail-Followup-To: emacs-devel@gnu.org Mail-Copies-To: never Received-SPF: pass client-ip=116.202.254.214; envelope-from=ged-emacs-devel@m.gmane-mx.org; helo=ciao.gmane.io X-Spam_score_int: -15 X-Spam_score: -1.6 X-Spam_bar: - X-Spam_report: (-1.6 / 5.0 requ) BAYES_00=-1.9, HEADER_FROM_DIFFERENT_DOMAINS=0.25, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-Mailman-Approved-At: Mon, 23 Oct 2023 08:44:31 -0400 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:311706 Archived-At: Eli Zaretskii wrote: >> This poor standard of doc strings is typical throughout >> cl-lib, even if not universal. > > Patches to improve the documentation of CL macros and > functions will be most welcome. `elint-current-buffer' does not find anything to correct in cl-lib.el. (checkdoc-current-buffer t) says the following: *** cl-lib.el: checkdoc-current-buffer cl-lib.el:133: Argument ‘keys’ should appear (as KEYS) in the doc string cl-lib.el:160: All variables and subroutines might as well have a documentation string cl-lib.el:166: All variables and subroutines might as well have a documentation string cl-lib.el:197: All variables and subroutines might as well have a documentation string cl-lib.el:197: All variables and subroutines might as well have a documentation string cl-lib.el:226: Arguments occur in the doc string out of order cl-lib.el:258: Argument ‘specs’ should appear (as SPECS) in the doc string cl-lib.el:357: Argument ‘cl-func’ should appear (as CL-FUNC) in the doc string cl-lib.el:450: Argument ‘rest’ should appear (as REST) in the doc string cl-lib.el:488: Argument ‘cl-item’ should appear (as CL-ITEM) in the doc string cl-lib.el:501: Argument ‘cl-new’ should appear (as CL-NEW) in the doc string cl-lib.el:510: All variables and subroutines might as well have a documentation string cl-lib.el:539: All variables and subroutines might as well have a documentation string cl-lib.el:577: Probably "returns" should be imperative "return" I CC this to the maintainer, but like to add that I personally have not experienced the documentation of cl-lib bad in any way. That said, for a person who knows the code well, those warnings should be a pretty quick fix. There are other files to cl-lib, of course. Emacs version: GNU Emacs 30.0.50 (build 1, x86_64-pc-linux-gnu, cairo version 1.16.0) of 2023-10-10 [commit 239db5d5162f6f9a4a6735e176c8d306f18e50e7] -- underground experts united https://dataswamp.org/~incal