From: "Basil L. Contovounesios" <contovob@tcd.ie>
To: Boruch Baum <boruch_baum@gmx.com>
Cc: 44107@debbugs.gnu.org
Subject: bug#44107: set-window-dedicated-p: args should be marked as optional
Date: Wed, 21 Oct 2020 01:13:08 +0100 [thread overview]
Message-ID: <87sga8wi5n.fsf@tcd.ie> (raw)
In-Reply-To: <20201020225532.5prrk5lnmpamwr6p@E15-2016.optimum.net> (Boruch Baum's message of "Tue, 20 Oct 2020 18:55:32 -0400")
Boruch Baum <boruch_baum@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
next prev parent reply other threads:[~2020-10-21 0:13 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-20 22:55 bug#44107: set-window-dedicated-p: args should be marked as optional Boruch Baum
2020-10-21 0:13 ` Basil L. Contovounesios [this message]
2020-10-21 0:18 ` Boruch Baum
2020-10-21 0:25 ` Basil L. Contovounesios
2020-10-21 0:47 ` Boruch Baum
2020-10-21 8:28 ` Basil L. Contovounesios
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87sga8wi5n.fsf@tcd.ie \
--to=contovob@tcd.ie \
--cc=44107@debbugs.gnu.org \
--cc=boruch_baum@gmx.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.