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: Marco Antoniotti <marcoxa <at> gmail.com>
To: 78543 <at> debbugs.gnu.org
Subject: bug#78543: 29.2; checkdoc misses some CL (cl-lib) constructs.
Date: Wed, 21 May 2025 22:38:48 +0200

[Message part 1 (text/plain, inline)]

Hi

The problem is with `checkdoc` not correctly handling some docstring
in `cl-lib` style declarations.

I have a function like

```
(cl-defun funky-keys (&key ((:this that) 42) &aux (the-beast 666))
    "Do something with THAT (passed via :THIS)"
    ...
    )
```

checkdoc insists on flagging :THIS and THE-BEAST as missing from the
docstring.

Another one is the following.

```
(cl-defgeneric gf (a s d f)
    (:documentation "Munge A, S, D, and F."))
```

checkdoc does not recognize the :documentation option (which is valid
according to cl-lib).

This problem is still visible in 30.1

All the best

Marco


-- 
Marco Antoniotti
Somewhere over the Rainbow

[Message part 2 (text/html, inline)]

Previous Next

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