From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Philip Kaludercic Newsgroups: gmane.emacs.devel Subject: Re: master ddfba511c19 1/3: Check shortdoc keywords and fix one mistake Date: Mon, 19 Feb 2024 18:59:03 +0000 Message-ID: <87h6i49t6w.fsf@posteo.net> References: <170836288097.22729.10027592558614089561@vcs2.savannah.gnu.org> <20240219171441.76EC3C3421F@vcs2.savannah.gnu.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="16471"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Mattias =?utf-8?Q?Engdeg=C3=A5rd?= To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Feb 19 19:59:56 2024 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 1rc8rs-00044C-Hb for ged-emacs-devel@m.gmane-mx.org; Mon, 19 Feb 2024 19:59:56 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rc8r8-00012I-9O; Mon, 19 Feb 2024 13:59:10 -0500 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 1rc8r6-00011x-OE for emacs-devel@gnu.org; Mon, 19 Feb 2024 13:59:08 -0500 Original-Received: from mout02.posteo.de ([185.67.36.66]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rc8r4-0004t5-KI for emacs-devel@gnu.org; Mon, 19 Feb 2024 13:59:08 -0500 Original-Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id D5102240101 for ; Mon, 19 Feb 2024 19:59:04 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1708369144; bh=v55Nh9VD51VjnIHmAbca4YJORFMnzK8oWBjHz4gKLyA=; h=From:To:Cc:Subject:OpenPGP:Date:Message-ID:MIME-Version: Content-Type:From; b=NNL8ziXAcqmZGqKqYuBvD1S8nVuzXgUoCPtIhCovg5COfXMLcVd4cgpJsTV2Gig3T TmJq5GDI8TEv6Bc4JRq1lxM9cguSCG71+WR0gw4dIYNdM8W/DkZiXamJbGNAzxFIdi EBo5mc9DshhL1arPRkreTXTCnxSaO8EMc2Bt3qceyvxb64XdvfgBqN0TRHWtuxSw9N 2c7A2/sfyLraMJcj9u2G4waOWAiWGw3M3TGDH2hS9Mq6nGzDsqrCw/FJQ6PFEeO9sR vmLDcJxqnBwELEs4aMkDBS2JhNCD2XFp0sWuEAGT3fw9c6ObiNF8E4KEuMpMCHIl4P HGdlkg5woTNrw== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4TdsJm2sRfz6ty5; Mon, 19 Feb 2024 19:59:04 +0100 (CET) In-Reply-To: <20240219171441.76EC3C3421F@vcs2.savannah.gnu.org> ("Mattias =?utf-8?Q?Engdeg=C3=83=C2=A5rd=22's?= message of "Mon, 19 Feb 2024 12:14:41 -0500 (EST)") OpenPGP: id=7126E1DE2F0CE35C770BED01F2C3CC513DB89F66; url="https://keys.openpgp.org/vks/v1/by-fingerprint/7126E1DE2F0CE35C770BED01F2C3CC513DB89F66"; preference=signencrypt Received-SPF: pass client-ip=185.67.36.66; envelope-from=philipk@posteo.net; helo=mout02.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 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, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action 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:316364 Archived-At: --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable This causes an error while compiling on my end: emacs-lisp/shortdoc.el:138:2: Error: Symbol=E2=80=99s function definition is void: shortdoc--check This would fix it, but I don't know the details of what is going on: --=-=-= Content-Type: text/plain Content-Disposition: inline diff --git a/lisp/emacs-lisp/shortdoc.el b/lisp/emacs-lisp/shortdoc.el index cde28985cd0..7597f601124 100644 --- a/lisp/emacs-lisp/shortdoc.el +++ b/lisp/emacs-lisp/shortdoc.el @@ -50,19 +50,19 @@ shortdoc-section '((t :inherit variable-pitch)) "Face used for a section.") -;;;###autoload -(defun shortdoc--check (group functions) - (let ((keywords '( :no-manual :args :eval :no-eval :no-value :no-eval* - :result :result-string :eg-result :eg-result-string :doc))) - (dolist (f functions) - (when (consp f) - (dolist (x f) - (when (and (keywordp x) (not (memq x keywords))) - (error "Shortdoc %s function `%s': bad keyword `%s'" - group (car f) x))))))) - ;;;###autoload (progn + (eval-and-compile + (defun shortdoc--check (group functions) + (let ((keywords '( :no-manual :args :eval :no-eval :no-value :no-eval* + :result :result-string :eg-result :eg-result-string :doc))) + (dolist (f functions) + (when (consp f) + (dolist (x f) + (when (and (keywordp x) (not (memq x keywords))) + (error "Shortdoc %s function `%s': bad keyword `%s'" + group (car f) x)))))))) + (defvar shortdoc--groups nil) (defmacro define-short-documentation-group (group &rest functions) --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Mattias Engdeg=C3=83=C2=A5rd writes: > branch: master > commit ddfba511c190e5bb44e44a50aef5ab8c08e3d798 > Author: Mattias Engdeg=C3=A5rd > Commit: Mattias Engdeg=C3=A5rd > > Check shortdoc keywords and fix one mistake >=20=20=20=20=20 > * lisp/emacs-lisp/shortdoc.el (shortdoc--check) > (define-short-documentation-group): Check that used keywords exist. > * lisp/emacs-lisp/shortdoc.el (list): Fix a typo. > --- > lisp/emacs-lisp/shortdoc.el | 14 +++++++++++++- > 1 file changed, 13 insertions(+), 1 deletion(-) > > diff --git a/lisp/emacs-lisp/shortdoc.el b/lisp/emacs-lisp/shortdoc.el > index a6a49c72f74..cde28985cd0 100644 > --- a/lisp/emacs-lisp/shortdoc.el > +++ b/lisp/emacs-lisp/shortdoc.el > @@ -50,6 +50,17 @@ > '((t :inherit variable-pitch)) > "Face used for a section.") >=20=20 > +;;;###autoload > +(defun shortdoc--check (group functions) > + (let ((keywords '( :no-manual :args :eval :no-eval :no-value :no-eval* > + :result :result-string :eg-result :eg-result-string= :doc))) > + (dolist (f functions) > + (when (consp f) > + (dolist (x f) > + (when (and (keywordp x) (not (memq x keywords))) > + (error "Shortdoc %s function `%s': bad keyword `%s'" > + group (car f) x))))))) > + > ;;;###autoload > (progn > (defvar shortdoc--groups nil) > @@ -118,6 +129,7 @@ A FUNC form can have any number of `:no-eval' (or `:n= o-value'), > `:no-eval*', `:result', `:result-string', `:eg-result' and > `:eg-result-string' properties." > (declare (indent defun)) > + (shortdoc--check group functions) > `(progn > (setq shortdoc--groups (delq (assq ',group shortdoc--groups) > shortdoc--groups)) > @@ -715,7 +727,7 @@ A FUNC form can have any number of `:no-eval' (or `:n= o-value'), > :eval (plist-get '(a 1 b 2 c 3) 'b)) > (plist-put > :no-eval (setq plist (plist-put plist 'd 4)) > - :eq-result (a 1 b 2 c 3 d 4)) > + :eg-result (a 1 b 2 c 3 d 4)) > (plist-member > :eval (plist-member '(a 1 b 2 c 3) 'b)) > "Data About Lists" --=-=-=--