From: Eli Zaretskii <eliz@gnu.org>
To: 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: Wed, 08 Oct 2014 16:32:38 +0300 [thread overview]
Message-ID: <83a956k7pl.fsf@gnu.org> (raw)
In-Reply-To: <986f56fa-af7e-4843-a0fa-047b2f49fb18@default>
> Date: Wed, 8 Oct 2014 06:20:49 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
> Cc: 18636-done@debbugs.gnu.org
>
> > > 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.
> >
> > That's not what happens, though. Each function extracts the info it
> > needs from whatever kind of argument it is passed, and then uses
> > that info.
>
> I said, "For example". Whatever the actual relation between the
> two is, it should be described. (Descriptions like "the information
> it needs" and "that info" are OK for here, but would not be helpful
> in the doc string.)
I'm not sure what you think the documentation should tell about this,
and why. Each function needs something different from its argument;
surely, describing all that in the doc string is counter-productive.
Whoever needs those details, should read the code.
IOW, what other details are required to correctly invoke and use these
functions?
next prev parent reply other threads:[~2014-10-08 13:32 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <<2cb10ab0-7eb3-43a8-9fc2-72374602b55f@default>
[not found] ` <<83oatmkgfy.fsf@gnu.org>
2014-10-08 13:20 ` bug#18636: 24.4.50; doc of `display-monitor-attributes-list' - DISPLAY? FRAME? Drew Adams
2014-10-08 13:32 ` Eli Zaretskii [this message]
[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
[not found] <<2382b3a5-6047-4b89-b211-3fef04714ae4@default>
[not found] ` <<83wq8emi60.fsf@gnu.org>
2014-10-06 2:41 ` Drew Adams
2014-10-08 10:24 ` 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
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=83a956k7pl.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=18636@debbugs.gnu.org \
--cc=drew.adams@oracle.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.