GNU bug report logs - #79128
31.0.50; shortdoc doesn't always display the correct arglist

Previous Next

Package: emacs;

Reported by: Robert Pluim <rpluim <at> gmail.com>

Date: Wed, 30 Jul 2025 13:27:02 UTC

Severity: normal

Found in version 31.0.50

Done: Eli Zaretskii <eliz <at> gnu.org>

Full log


View this message in rfc822 format

From: Robert Pluim <rpluim <at> gmail.com>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 79128 <at> debbugs.gnu.org, Eli Zaretskii <eliz <at> gnu.org>
Subject: bug#79128: 31.0.50; shortdoc doesn't always display the correct arglist
Date: Tue, 05 Aug 2025 09:41:48 +0200
>>>>> On Mon, 04 Aug 2025 16:10:09 -0400, Stefan Monnier <monnier <at> iro.umontreal.ca> said:

    >> which is defined as:
    >> 
    >> (cl-defgeneric seq-concatenate (type &rest sequences)
    >> "Concatenate SEQUENCES into a single sequence of type TYPE.
    >> TYPE must be one of following symbols: `vector', `string' or `list'.
    >> 
    >> \n(fn TYPE SEQUENCE...)"
    >> 
    >> The signature is correct, but doesnʼt obey the "(fn" thing, nor does
    >> it preserve the argument names.

    Stefan> The (fn TYPE SEQUENCE...) syntax is not a "proper" formal arglist, so
    Stefan> `help-function-arglist` explicitly rejects it.  I'd just delete the
    Stefan> `\n(fn TYPE SEQUENCE...)` from the docstring.

That format is very common though, so I donʼt think Iʼll be wholesale
deleting those.

Your patch is good to go as far as Iʼm concerned.

Robert
-- 




This bug report was last modified 6 days ago.

Previous Next


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