From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#18636: 24.4.50; doc of `display-monitor-attributes-list' - DISPLAY? FRAME? Date: Wed, 08 Oct 2014 16:32:38 +0300 Message-ID: <83a956k7pl.fsf@gnu.org> References: <2cb10ab0-7eb3-43a8-9fc2-72374602b55f@default> <83oatmkgfy.fsf@gnu.org> <986f56fa-af7e-4843-a0fa-047b2f49fb18@default> Reply-To: Eli Zaretskii NNTP-Posting-Host: plane.gmane.org X-Trace: ger.gmane.org 1412775246 15898 80.91.229.3 (8 Oct 2014 13:34:06 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 8 Oct 2014 13:34:06 +0000 (UTC) Cc: 18636@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Oct 08 15:33:59 2014 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1XbrNO-0006zm-Jp for geb-bug-gnu-emacs@m.gmane.org; Wed, 08 Oct 2014 15:33:58 +0200 Original-Received: from localhost ([::1]:36286 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XbrNN-00042u-LU for geb-bug-gnu-emacs@m.gmane.org; Wed, 08 Oct 2014 09:33:57 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:58855) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XbrMc-0003BN-9S for bug-gnu-emacs@gnu.org; Wed, 08 Oct 2014 09:33:15 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XbrMV-0008EP-By for bug-gnu-emacs@gnu.org; Wed, 08 Oct 2014 09:33:10 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:45994) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XbrMV-0008EB-8d for bug-gnu-emacs@gnu.org; Wed, 08 Oct 2014 09:33:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1XbrMU-0007Ta-Fo for bug-gnu-emacs@gnu.org; Wed, 08 Oct 2014 09:33:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 08 Oct 2014 13:33:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 18636 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 18636-submit@debbugs.gnu.org id=B18636.141277515428704 (code B ref 18636); Wed, 08 Oct 2014 13:33:02 +0000 Original-Received: (at 18636) by debbugs.gnu.org; 8 Oct 2014 13:32:34 +0000 Original-Received: from localhost ([127.0.0.1]:37558 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1XbrM1-0007Su-CC for submit@debbugs.gnu.org; Wed, 08 Oct 2014 09:32:33 -0400 Original-Received: from mtaout29.012.net.il ([80.179.55.185]:56054) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1XbrLv-0007Se-DV for 18636@debbugs.gnu.org; Wed, 08 Oct 2014 09:32:28 -0400 Original-Received: from conversion-daemon.mtaout29.012.net.il by mtaout29.012.net.il (HyperSendmail v2007.08) id <0ND400N00NHJLW00@mtaout29.012.net.il> for 18636@debbugs.gnu.org; Wed, 08 Oct 2014 16:31:34 +0300 (IDT) Original-Received: from HOME-C4E4A596F7 ([87.69.4.28]) by mtaout29.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0ND400JVVO8MBP60@mtaout29.012.net.il>; Wed, 08 Oct 2014 16:31:34 +0300 (IDT) In-reply-to: <986f56fa-af7e-4843-a0fa-047b2f49fb18@default> X-012-Sender: halo1@inter.net.il X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 140.186.70.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:94294 > Date: Wed, 8 Oct 2014 06:20:49 -0700 (PDT) > From: Drew Adams > 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?