From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>, Drew Adams <drew.adams@oracle.com>
Cc: 18636@debbugs.gnu.org
Subject: bug#18636: 24.4.50; doc of `display-monitor-attributes-list' - DISPLAY? FRAME?
Date: Sun, 5 Oct 2014 19:41:21 -0700 (PDT) [thread overview]
Message-ID: <2cb10ab0-7eb3-43a8-9fc2-72374602b55f@default> (raw)
In-Reply-To: <<83wq8emi60.fsf@gnu.org>>
> > I find it unclear that the optional parameter of
> > `display-monitor-attributes-list' is named DISPLAY, and is
> > referred to as a display in the doc string, and yet in
> > `frame-monitor-attributes' it is arg FRAME that is passed
> > to `display-monitor-attributes-list'.
> >
> > Is the argument of `display-monitor-attributes-list' a
> > display or a frame?
>
> It can be either.
OK. Then the doc should say so. And it should call out the
relation between the two. For example, if a frame is passed
and its display is used (= its `display' frame parameter),
then say so.
> > What about other functions, such as `display-pixel-height', which
> > call `display-monitor-attributes-list'? They seem to pass their
> > DISPLAY arg to it. Is this arg too something that can be (or
> > is always?) a frame? The doc string of `display-pixel-height'
> > (for example) says:
> >
> > "If DISPLAY is omitted or nil, it defaults to the selected
> > frame's display."
> >
> > That would seem to suggest that a frame is not a display, but
> > rather it _has_ a display.
>
> A frame is not a display, but these functions accept either one.
Their doc should say so.
> If you make a list of the functions where the doc string is not
> explicit about this fact, I will fix them.
Thank you. I think this is the case for all of the 20 functions
described in (elisp) `Display Feature Testing', but there might
be others as well.
next parent reply other threads:[~2014-10-06 2:41 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <<2382b3a5-6047-4b89-b211-3fef04714ae4@default>
[not found] ` <<83wq8emi60.fsf@gnu.org>
2014-10-06 2:41 ` Drew Adams [this message]
2014-10-08 10:24 ` bug#18636: 24.4.50; doc of `display-monitor-attributes-list' - DISPLAY? FRAME? Eli Zaretskii
2014-10-05 19:05 ` Drew Adams
2014-10-05 19:27 ` Eli Zaretskii
2014-10-08 10:44 ` Andy Moreton
2014-10-08 11:17 ` Eli Zaretskii
[not found] <<2cb10ab0-7eb3-43a8-9fc2-72374602b55f@default>
[not found] ` <<83oatmkgfy.fsf@gnu.org>
2014-10-08 13:20 ` Drew Adams
2014-10-08 13:32 ` Eli Zaretskii
[not found] ` <<986f56fa-af7e-4843-a0fa-047b2f49fb18@default>
[not found] ` <<83a956k7pl.fsf@gnu.org>
2014-10-08 14:04 ` Drew Adams
2014-10-08 14:10 ` Eli Zaretskii
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=2cb10ab0-7eb3-43a8-9fc2-72374602b55f@default \
--to=drew.adams@oracle.com \
--cc=18636@debbugs.gnu.org \
--cc=eliz@gnu.org \
/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.