GNU bug report logs - #18039
24.3; Broken docstring in cl-style functions

Previous Next

Package: emacs;

Reported by: Thorsten Jolitz <tjolitz <at> gmail.com>

Date: Wed, 16 Jul 2014 23:25:02 UTC

Severity: normal

Merged with 21839

Found in versions 24.3, 25.0.50, 24.5

Fixed in version 25.0.94

Done: Noam Postavsky <npostavs <at> users.sourceforge.net>

Bug is archived. No further changes may be made.

Full log

Message #8 received at 18039 <at> debbugs.gnu.org (full text, mbox):

From: Michael Heerdegen <michael_heerdegen <at> web.de>
To: Thorsten Jolitz <tjolitz <at> gmail.com>
Cc: 18039 <at> debbugs.gnu.org
Subject: Re: bug#18039: 24.3; Broken docstring in cl-style functions
Date: Thu, 17 Jul 2014 02:31:17 +0200

Thorsten Jolitz <tjolitz <at> gmail.com> writes:

> thus the bug seems to be in the combination of normal args
> 'key-val-strg and &key args with default values '(crlf "\n"). 

Indeed. Eval this in emacs -Q:

M-: (require 'cl)
M-: (cl-defun test (&key (c "\n")) "Test" nil)
M-: (symbol-function 'test)

==>

(lambda (&rest --cl-rest--) "Test

(fn 40 102 110 32 38 107 101 121 32 40 67 32 34 10 34 41 41) ...)

The newline character in the (printed) argument list makes a
difference in this expression in help-add-fundoc-usage:

    (if (and (stringp arglist)
	     (string-match "\\`([^ ]+\\(.*\\))\\'" arglist))
	(concat "(fn" (match-string 1 arglist) ")")
      (format "%S" (help-make-usage 'fn arglist)))

(help-make-usage doesn't seem to expect a stringp arglist).  Should the
regexp given to string-match be changed?


Michael.
This bug report was last modified 8 years and 335 days ago.

Previous Next

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