bug#8853: 24.0.50; regression: doc string of `special-display-popup-frame'

bug#8853: 24.0.50; regression: doc string of `special-display-popup-frame'

[Drew Adams]

This regression was introduced in release 23.1.  Prior to that release,
the doc string said, correctly,
"If ARGS is a list whose car is a symbol, use (car ARGS) as a function
to do the work.  Pass it BUFFER as first arg, and (cdr ARGS) as the
rest of its args."
 
Now it says, incorrectly,
"If ARGS is a list whose car is a symbol, use (car ARGS) as a
function to do the work.  Pass it BUFFER as first argument,
and (cdr ARGS) as second."
 
If ARGS is a list whose car is a symbol `f', then
`special-display-popup-frame' invokes `f', passing it as arguments,
BUFFER followed by all of the elements in (cdr ARGS).  The arity of `f'
is the length of ARGS, not just 2.  We do not pass `f' (cdr ARGS) as a
second argument.
 

In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
 of 2011-06-13 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.5) --no-opt --cflags
-Ic:/build/include'
 

bug#8853: 24.0.50; regression: doc string of `special-display-popup-frame'

[martin rudalics]

> This regression was introduced in release 23.1.  Prior to that release,
> the doc string said, correctly,
> "If ARGS is a list whose car is a symbol, use (car ARGS) as a function
> to do the work.  Pass it BUFFER as first arg, and (cdr ARGS) as the
> rest of its args."
>  
> Now it says, incorrectly,
> "If ARGS is a list whose car is a symbol, use (car ARGS) as a
> function to do the work.  Pass it BUFFER as first argument,
> and (cdr ARGS) as second."
>  
> If ARGS is a list whose car is a symbol `f', then
> `special-display-popup-frame' invokes `f', passing it as arguments,
> BUFFER followed by all of the elements in (cdr ARGS).  The arity of `f'
> is the length of ARGS, not just 2.  We do not pass `f' (cdr ARGS) as a
> second argument.

Indeed.  Could someone please restore the old doc-string in Emacs 23?

martin

bug#8853: 24.0.50; regression: doc string of `special-display-popup-frame'

[Chong Yidong]

martin rudalics <rudalics@gmx.at> writes:

>> This regression was introduced in release 23.1.  Prior to that release,
>> the doc string said, correctly,
>> "If ARGS is a list whose car is a symbol, use (car ARGS) as a function
>> to do the work.  Pass it BUFFER as first arg, and (cdr ARGS) as the
>> rest of its args."
>>  Now it says, incorrectly,
>> "If ARGS is a list whose car is a symbol, use (car ARGS) as a
>> function to do the work.  Pass it BUFFER as first argument,
>> and (cdr ARGS) as second."
>>  If ARGS is a list whose car is a symbol `f', then
>> `special-display-popup-frame' invokes `f', passing it as arguments,
>> BUFFER followed by all of the elements in (cdr ARGS).  The arity of `f'
>> is the length of ARGS, not just 2.  We do not pass `f' (cdr ARGS) as a
>> second argument.
>
> Indeed.  Could someone please restore the old doc-string in Emacs 23?

Fixed.

bug#8853: 24.0.50; regression: doc string of `special-display-popup-frame'

[Drew Adams]

> >> This regression was introduced in release 23.1.  Prior to 
> >> that release, the doc string said, correctly,
> >> "If ARGS is a list whose car is a symbol, use (car ARGS) 
> >> as a function to do the work.  Pass it BUFFER as first arg,
> >> and (cdr ARGS) as the rest of its args."

What's important here is "as the _rest_ of its args".

> >> Now it says, incorrectly, "If ARGS is a list whose car
> >> is a symbol, use (car ARGS) as a function to do the work.
> >> Pass it BUFFER as first argument, and (cdr ARGS) as second."
> >>
> >> If ARGS is a list whose car is a symbol `f', then
> >> `special-display-popup-frame' invokes `f', passing it as
> >> arguments, BUFFER followed by all of the elements in
> >> (cdr ARGS).  The arity of `f' is the length of ARGS, not
> >> just 2.  We do not pass `f' (cdr ARGS) as a second argument.
> >
> > Indeed.  Could someone please restore the old doc-string in 
> > Emacs 23?
> 
> Fixed.

No, I do not see this fixed in the latest Windows build of Emacs 24:

In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
 of 2011-06-27 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.5) --no-opt --cflags
-Ic:/build/include'

It still says: "Pass it BUFFER as first argument, and (cdr ARGS) as second."

The point of the bug fix should be to replace "as second" by "as the rest of its
args" or equivalent.  Thx.

bug#8853: 24.0.50; regression: doc string of `special-display-popup-frame'

[Glenn Morris]

> > > Indeed.  Could someone please restore the old doc-string in Emacs 23?
> > 
> > Fixed.
> 
> No, I do not see this fixed in the latest Windows build of Emacs 24:

As indicated, it was fixed in the emacs-23 branch. This and other
changes will be merged to trunk in due course. Please be less eager to
reopen bugs.

bug#8853: 24.0.50; regression: doc string of `special-display-popup-frame'

[Drew Adams]

FYI - I got an archived response for my report, so I went ahead and unarchived &
reopened it.

bug#8853: 24.0.50; regression: doc string of `special-display-popup-frame'

[Chong Yidong]

"Drew Adams" <drew.adams@oracle.com> writes:

>> > Indeed.  Could someone please restore the old doc-string in 
>> > Emacs 23?
>> 
>> Fixed.
>
> No, I do not see this fixed in the latest Windows build of Emacs 24:

The doc-string in Emacs 23 was wrong too, so restoring it did not fix
things.  Should be fixed now, sorry for the confusion.