GNU bug report logs - #44107
set-window-dedicated-p: args should be marked as optional

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 44107 in the body.
You can then email your comments to 44107 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

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

From: Boruch Baum <boruch_baum <at> gmx.com>
To: Emacs Bug Reporting <bug-gnu-emacs <at> gnu.org>
Subject: set-window-dedicated-p: args should be marked as optional
Date: Tue, 20 Oct 2020 18:55:32 -0400

The definition for function `set-window-dedicated-p' indicates that its
two arguments are required, but the docstring indicates that the
arguments are optional. I haven't looked at the C source code, but my
testing indicates that the arguments really are optional, so the
description should mark them as such, ie.

  (set-window-dedicated-p &optional WINDOW FLAG)

--
hkp://keys.gnupg.net
CA45 09B5 5351 7C11 A9D1  7286 0036 9E45 1595 8BC0

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

From: "Basil L. Contovounesios" <contovob <at> tcd.ie>
To: Boruch Baum <boruch_baum <at> gmx.com>
Cc: 44107 <at> debbugs.gnu.org
Subject: Re: bug#44107: set-window-dedicated-p: args should be marked as
 optional
Date: Wed, 21 Oct 2020 01:13:08 +0100

Boruch Baum <boruch_baum <at> gmx.com> writes:

> The definition for function `set-window-dedicated-p' indicates that its
> two arguments are required, but the docstring indicates that the
> arguments are optional.

I assume you're referring to the following sentence:

  WINDOW must be a live window and defaults to the selected one.

The default case in question is when WINDOW is specified as nil.
Perhaps this could be made more explicit, but it's a pretty pervasive
idiom.

In other words, set-window-dedicated-p takes two positional arguments
and its docstring does not intentionally try to suggest otherwise.

> I haven't looked at the C source code, but my
> testing indicates that the arguments really are optional, so the
> description should mark them as such, ie.
>
>   (set-window-dedicated-p &optional WINDOW FLAG)

Could you please describe your testing in more detail?  Evaluating

  (set-window-dedicated-p)

gives me

  (wrong-number-of-arguments set-window-dedicated-p 0)

since at least as far back as Emacs 24.5, so I'm not sure how you
reached that conclusion.

Or are you suggesting that the function's arguments _be made_ optional,
since they are both allowed to be nil?  (A positional argument that can
be nil is not the same as an optional argument.)

-- 
Basil

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

From: Boruch Baum <boruch_baum <at> gmx.com>
To: "Basil L. Contovounesios" <contovob <at> tcd.ie>
Cc: 44107 <at> debbugs.gnu.org
Subject: Re: bug#44107: set-window-dedicated-p: args should be marked as
 optional
Date: Tue, 20 Oct 2020 20:18:23 -0400

On 2020-10-21 01:13, Basil L. Contovounesios wrote:
> Or are you suggesting that the function's arguments _be made_ optional,
> since they are both allowed to be nil?  (A positional argument that can
> be nil is not the same as an optional argument.)

Yes, I see I was unclear about that. They should be made optional since
both may be nil.

--
hkp://keys.gnupg.net
CA45 09B5 5351 7C11 A9D1  7286 0036 9E45 1595 8BC0

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

From: "Basil L. Contovounesios" <contovob <at> tcd.ie>
To: Boruch Baum <boruch_baum <at> gmx.com>
Cc: 44107 <at> debbugs.gnu.org
Subject: Re: bug#44107: set-window-dedicated-p: args should be marked as
 optional
Date: Wed, 21 Oct 2020 01:25:43 +0100

Boruch Baum <boruch_baum <at> gmx.com> writes:

> On 2020-10-21 01:13, Basil L. Contovounesios wrote:
>> Or are you suggesting that the function's arguments _be made_ optional,
>> since they are both allowed to be nil?  (A positional argument that can
>> be nil is not the same as an optional argument.)
>
> Yes, I see I was unclear about that. They should be made optional since
> both may be nil.

I don't think that would make sense, since

  (set-window-dedicated-p nil nil)

undedicates the selected window, but if I saw its (proposed) equivalent

  (set-window-dedicated-p)

I'd think the opposite.

-- 
Basil

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

From: Boruch Baum <boruch_baum <at> gmx.com>
To: "Basil L. Contovounesios" <contovob <at> tcd.ie>
Cc: 44107 <at> debbugs.gnu.org
Subject: Re: bug#44107: set-window-dedicated-p: args should be marked as
 optional
Date: Tue, 20 Oct 2020 20:47:07 -0400

On 2020-10-21 01:25, Basil L. Contovounesios wrote:
> Boruch Baum <boruch_baum <at> gmx.com> writes:
>
> > On 2020-10-21 01:13, Basil L. Contovounesios wrote:
> >> Or are you suggesting that the function's arguments _be made_ optional,
> >> since they are both allowed to be nil?  (A positional argument that can
> >> be nil is not the same as an optional argument.)
> >
> > Yes, I see I was unclear about that. They should be made optional since
> > both may be nil.
>
> I don't think that would make sense, since
>
>   (set-window-dedicated-p nil nil)
>
> undedicates the selected window, but if I saw its (proposed) equivalent
>
>   (set-window-dedicated-p)
>
> I'd think the opposite.

Good point. And since WINDOW is sequentially the first arg, it alone
can't be optional. Unless you or someone else has a better idea then,
this report should be closed.

--
hkp://keys.gnupg.net
CA45 09B5 5351 7C11 A9D1  7286 0036 9E45 1595 8BC0

Message #24 received at 44107-done <at> debbugs.gnu.org (full text, mbox):

From: "Basil L. Contovounesios" <contovob <at> tcd.ie>
To: Boruch Baum <boruch_baum <at> gmx.com>
Cc: 44107-done <at> debbugs.gnu.org
Subject: Re: bug#44107: set-window-dedicated-p: args should be marked as
 optional
Date: Wed, 21 Oct 2020 09:28:38 +0100

tags 44107 wontfix
close 44107
quit

Boruch Baum <boruch_baum <at> gmx.com> writes:

> Good point. And since WINDOW is sequentially the first arg, it alone
> can't be optional. Unless you or someone else has a better idea then,
> this report should be closed.

Thanks, I'll close it for now then.  If someone comes up with a better
idea we can just reopen it.

-- 
Basil

Previous Next

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