From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" Newsgroups: gmane.emacs.bugs Subject: bug#5105: 23.1; doc string of facemenu-set-face Date: Fri, 15 Jul 2011 09:13:10 -0700 Message-ID: <46B162590B174FA18FC402384C600E59@us.oracle.com> References: <3750B6C4FBBD4720926A2FC57778497F@us.oracle.com> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: dough.gmane.org 1310749517 8498 80.91.229.12 (15 Jul 2011 17:05:17 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Fri, 15 Jul 2011 17:05:17 +0000 (UTC) Cc: 5105@debbugs.gnu.org To: "'Lars Magne Ingebrigtsen'" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Jul 15 19:05:11 2011 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([140.186.70.17]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1Qhlp9-0007lU-7I for geb-bug-gnu-emacs@m.gmane.org; Fri, 15 Jul 2011 19:05:11 +0200 Original-Received: from localhost ([::1]:41024 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qhlp7-0006py-VH for geb-bug-gnu-emacs@m.gmane.org; Fri, 15 Jul 2011 13:05:10 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:53694) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qhl1g-0008Td-KJ for bug-gnu-emacs@gnu.org; Fri, 15 Jul 2011 12:14:05 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Qhl1f-0008Bf-2K for bug-gnu-emacs@gnu.org; Fri, 15 Jul 2011 12:14:04 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:44666) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qhl1e-0008BZ-Nl for bug-gnu-emacs@gnu.org; Fri, 15 Jul 2011 12:14:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1Qhl1d-00082y-VO; Fri, 15 Jul 2011 12:14:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: "Drew Adams" Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 15 Jul 2011 16:14:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 5105 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: wontfix Original-Received: via spool by 5105-submit@debbugs.gnu.org id=B5105.131074640830869 (code B ref 5105); Fri, 15 Jul 2011 16:14:01 +0000 Original-Received: (at 5105) by debbugs.gnu.org; 15 Jul 2011 16:13:28 +0000 Original-Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qhl16-00081p-5p for submit@debbugs.gnu.org; Fri, 15 Jul 2011 12:13:28 -0400 Original-Received: from acsinet15.oracle.com ([141.146.126.227]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qhl14-00081a-Mj for 5105@debbugs.gnu.org; Fri, 15 Jul 2011 12:13:27 -0400 Original-Received: from rtcsinet21.oracle.com (rtcsinet21.oracle.com [66.248.204.29]) by acsinet15.oracle.com (Switch-3.4.4/Switch-3.4.4) with ESMTP id p6FGDI45012814 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Fri, 15 Jul 2011 16:13:20 GMT Original-Received: from acsmt358.oracle.com (acsmt358.oracle.com [141.146.40.158]) by rtcsinet21.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id p6FGDGwi000285 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Fri, 15 Jul 2011 16:13:17 GMT Original-Received: from abhmt119.oracle.com (abhmt119.oracle.com [141.146.116.71]) by acsmt358.oracle.com (8.12.11.20060308/8.12.11) with ESMTP id p6FGDBp8023863; Fri, 15 Jul 2011 11:13:11 -0500 Original-Received: from dradamslap1 (/10.159.34.212) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Fri, 15 Jul 2011 09:13:11 -0700 X-Mailer: Microsoft Office Outlook 11 In-Reply-To: Thread-Index: AcxDCS+k/gjj/Br5QFW3jsovW35OOwAAB+WQ X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6109 X-Source-IP: rtcsinet21.oracle.com [66.248.204.29] X-CT-RefId: str=0001.0A090209.4E206720.00EF:SCFSTAT5015188, ss=1, re=-4.000, fgs=0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Fri, 15 Jul 2011 12:14:01 -0400 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) 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:49179 Archived-At: > >> > The doc string should say explicitly what the args are. In > >> > particular, it should say that FACE can be a string or a symbol. > >> > >> What does FACE mean if FACE is a string? > > > > You tell me. And other users. > > > > The answer is apparently...the face name. > > E.g., you can use the symbol `bold' or the string "bold". > > Then I think it should be left undocumented. That the command takes a > string sounds like an historical artifact and should not be > encouraged. > > I'm closing this report. What? Why are you arbitrarily deciding that? Why not assume that allowing a string is a good thing, a purposeful design decision? What makes you conclude that this is not something to be encouraged? We have many places in Emacs where we allow an arg to be either a thing or its name. Think of all of the BUFFER args that can be a buffer or a buffer name. Recently some code has been changed to name such parameters BLAH-OR-NAME instead of BLAH. An example is the bookmark.el code. (I personally think that's a mistake - the doc string still needs to say that BLAH-OR-NAME can be a BLAH or its name.) But the point here is that allowing FACE to be a string is a *feature*, not a "historical artifact". There is no reason to lose this feature, and no reason it should not be documented. You should not be designing on the fly that way. This is a doc bug. The doc should mention that FACE can be a face or its name. Nothing new about this.