GNU bug report logs - #78543
29.2; checkdoc misses some CL (cl-lib) constructs.

Previous Next

Full log

View this message in rfc822 format

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: marcoxa <at> gmail.com, 78543 <at> debbugs.gnu.org
Subject: bug#78543: 29.2; checkdoc misses some CL (cl-lib) constructs.
Date: Sat, 31 May 2025 19:20:58 +0300

> From: Stefan Monnier <monnier <at> iro.umontreal.ca>
> Cc: Marco Antoniotti <marcoxa <at> gmail.com>,  78543 <at> debbugs.gnu.org
> Date: Sat, 31 May 2025 10:56:19 -0400
> 
> >> ```
> >> (cl-defun funky-keys (&key ((:this that) 42) &aux (the-beast 666))
> >>     "Do something with THAT (passed via :THIS)"
> >>     ...
> >>     )
> >> ```
> 
> FWIW, I consider this `(:this that)` of CL's keyword args to be
> a misfeature, so I'm happy for Emacs to behave suboptimally here, tho
> I'd prefer for cl-lib to stop supporting it.

But do you have anything against the patch I proposed to install?

> > Also, I believe that THE-BEAST should
> > indeed be mentioned in the doc string.
> 
> Why?  It's not part of the function's exposed interface.
> It's just a weird way to define a local variable.
> 
> I also find this `&aux` thingy to be a misfeature in CL, which we
> usually shouldn't support [ tho currently it's admittedly handy at
> times in `cl-defstruct` constructors.  ], so I'm not sure it's worth
> complicating checkdoc for it.

I didn't suggest complicating checkdoc due to &aux arguments.  So we
basically agree here.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.