Eldoc cannot handle CL-style paramlist with default values?

Eldoc cannot handle CL-style paramlist with default values?

[Thorsten Jolitz]

Hi List, 

I used cl-style 'defun*' recently and noted that for this function

,----
| (defun* puml-pack (&rest args &key ins &allow-other-keys)
`----

eldoc correctly (?) shows

,----
| puml-pack: (&rest ARGS &KEY INS &ALLOW-OTHER-KEYS)
`----

in the minibuffer, but for this function

,----
| (defun* puml-start-activity (arrow &key (lbl "") (nm "") (crlf "\n")
| (pre "(*)") suf ins)
`----

it shows

,----
| puml-start-activity: (40 102 110 32 65 82 82 79 87 32 38 107 101 121 32
| 40 76 66 76 32 34 34 41 32 40 78 77 32 34 34 41 32 40 67 82 76 70 3\
| 2 34 10 34 41 32 40 80 82 69 32 34 40 42 41 34 41 32 83 85 70 32 73 78
| 83 41)
`----

Assuming this is ASCII I get (not surprisingly)

,----
| (fn ARROW &key ...)
`----

-- 
cheers,
Thorsten

Re: Eldoc cannot handle CL-style paramlist with default values?

[Michael Heerdegen]

Thorsten Jolitz <tjolitz@gmail.com> writes:

> ,----
> | (defun* puml-start-activity (arrow &key (lbl "") (nm "") (crlf "\n")
> | (pre "(*)") suf ins)
> `----
>
> it shows
>
> ,----
> | puml-start-activity: (40 102 110 32 65 82 82 79 87 32 38 107 101 121 32
> | 40 76 66 76 32 34 34 41 32 40 78 77 32 34 34 41 32 40 67 82 76 70 3\
> | 2 34 10 34 41 32 40 80 82 69 32 34 40 42 41 34 41 32 83 85 70 32 73 78
> | 83 41)
> `----
>
> Assuming this is ASCII I get (not surprisingly)
>
> ,----
> | (fn ARROW &key ...)
> `----

Looks like a bug.  However, not a bug in eldoc: when you call
describe-function, you'll see that the docstring of the defined function
is broken.

Can you please make a bug report?


Thanks,

Michael.

Re: Eldoc cannot handle CL-style paramlist with default values?

[Thorsten Jolitz]

Michael Heerdegen <michael_heerdegen@web.de> writes:

> Thorsten Jolitz <tjolitz@gmail.com> writes:
>
>> ,----
>> | (defun* puml-start-activity (arrow &key (lbl "") (nm "") (crlf "\n")
>> | (pre "(*)") suf ins)
>> `----
>>
>> it shows
>>
>> ,----
>> | puml-start-activity: (40 102 110 32 65 82 82 79 87 32 38 107 101 121 32
>> | 40 76 66 76 32 34 34 41 32 40 78 77 32 34 34 41 32 40 67 82 76 70 3\
>> | 2 34 10 34 41 32 40 80 82 69 32 34 40 42 41 34 41 32 83 85 70 32 73 78
>> | 83 41)
>> `----
>>
>> Assuming this is ASCII I get (not surprisingly)
>>
>> ,----
>> | (fn ARROW &key ...)
>> `----
>
> Looks like a bug.  However, not a bug in eldoc: when you call
> describe-function, you'll see that the docstring of the defined function
> is broken.
>
> Can you please make a bug report?

Done.

Its actually the combination of normal args with &key arg with default
values that does not seem to work, e.g. 

,----
| (defun* foo (arg1 arg2 &key (arg3 "default")))
`----

-- 
cheers,
Thorsten

Re: Eldoc cannot handle CL-style paramlist with default values?

[Michael Heerdegen]

Thorsten Jolitz <tjolitz@gmail.com> writes:

> > Can you please make a bug report?
>
> Done.

Thanks!

> Its actually the combination of normal args with &key arg with default
> values that does not seem to work, e.g. 
>
> ,----
> | (defun* foo (arg1 arg2 &key (arg3 "default")))
> `----

No, that example works.  Actually, the newline character in your
previous post seems to be the culprit, because the docstring building
code assumes that the printed argument list is a one-lined string.


Michael.

Re: Eldoc cannot handle CL-style paramlist with default values?

[Thorsten Jolitz]

Michael Heerdegen <michael_heerdegen@web.de> writes:

> Thorsten Jolitz <tjolitz@gmail.com> writes:
>
>> > Can you please make a bug report?
>>
>> Done.
>
> Thanks!
>
>> Its actually the combination of normal args with &key arg with default
>> values that does not seem to work, e.g. 
>>
>> ,----
>> | (defun* foo (arg1 arg2 &key (arg3 "default")))
>> `----
>
> No, that example works.  Actually, the newline character in your
> previous post seems to be the culprit, because the docstring building
> code assumes that the printed argument list is a one-lined string.

Yes, you are right. I would call this a (kind of) bug, because I
have a use case where its convenient to put a newline as an arg's default
value and only sometimes set it explicitly to nil, so it should work
from (at least one) user's perspective. 

-- 
cheers,
Thorsten

Re: Eldoc cannot handle CL-style paramlist with default values?

[Michael Heerdegen]

Thorsten Jolitz <tjolitz@gmail.com> writes:

> I would call this a (kind of) bug, because I have a use case where its
> convenient to put a newline as an arg's default value and only
> sometimes set it explicitly to nil, so it should work from (at least
> one) user's perspective.

It's a bug, clearly.  Often people are just to shy to report such
things.


Michael.