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#22206: 25.1.50; doc string of `define-minor-mode' Date: Fri, 18 Dec 2015 12:09:39 -0800 (PST) Message-ID: References: <> <<83d1u3wo20.fsf@gnu.org>> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1450469429 9044 80.91.229.3 (18 Dec 2015 20:10:29 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 18 Dec 2015 20:10:29 +0000 (UTC) Cc: 22206@debbugs.gnu.org To: Eli Zaretskii , Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Dec 18 21:10:11 2015 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 1aA1Lu-0006TY-Ad for geb-bug-gnu-emacs@m.gmane.org; Fri, 18 Dec 2015 21:10:10 +0100 Original-Received: from localhost ([::1]:34920 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aA1Lt-0002sE-9Y for geb-bug-gnu-emacs@m.gmane.org; Fri, 18 Dec 2015 15:10:09 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:33218) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aA1Lp-0002qg-Ef for bug-gnu-emacs@gnu.org; Fri, 18 Dec 2015 15:10:06 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1aA1Lm-00007l-89 for bug-gnu-emacs@gnu.org; Fri, 18 Dec 2015 15:10:05 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:48441) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aA1Lm-00007c-5V for bug-gnu-emacs@gnu.org; Fri, 18 Dec 2015 15:10:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84) (envelope-from ) id 1aA1Ll-0002HQ-TY for bug-gnu-emacs@gnu.org; Fri, 18 Dec 2015 15:10:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 18 Dec 2015 20:10:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 22206 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 22206-submit@debbugs.gnu.org id=B22206.14504693888741 (code B ref 22206); Fri, 18 Dec 2015 20:10:01 +0000 Original-Received: (at 22206) by debbugs.gnu.org; 18 Dec 2015 20:09:48 +0000 Original-Received: from localhost ([127.0.0.1]:56043 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84) (envelope-from ) id 1aA1LY-0002Gv-K4 for submit@debbugs.gnu.org; Fri, 18 Dec 2015 15:09:48 -0500 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:17371) by debbugs.gnu.org with esmtp (Exim 4.84) (envelope-from ) id 1aA1LW-0002Gg-PX for 22206@debbugs.gnu.org; Fri, 18 Dec 2015 15:09:47 -0500 Original-Received: from aserv0022.oracle.com (aserv0022.oracle.com [141.146.126.234]) by aserp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id tBIK9exf021716 (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Fri, 18 Dec 2015 20:09:41 GMT Original-Received: from aserv0121.oracle.com (aserv0121.oracle.com [141.146.126.235]) by aserv0022.oracle.com (8.13.8/8.13.8) with ESMTP id tBIK9ekp008060 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=FAIL); Fri, 18 Dec 2015 20:09:40 GMT Original-Received: from abhmp0011.oracle.com (abhmp0011.oracle.com [141.146.116.17]) by aserv0121.oracle.com (8.13.8/8.13.8) with ESMTP id tBIK9emC003867; Fri, 18 Dec 2015 20:09:40 GMT In-Reply-To: <<83d1u3wo20.fsf@gnu.org>> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9 (901082) [OL 12.0.6691.5000 (x86)] X-Source-IP: aserv0022.oracle.com [141.146.126.234] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.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:110157 Archived-At: > > Unlike (elisp) `Defining Minor Modes', the doc string does not say that > > LIGHTER is a string and that keyword :lighter has a string value. > > Please mention that the value is a string. >=20 > The doc string says: > Optional LIGHTER is displayed in the mode line when the mode is on. >=20 > What else could it possibly be, except a string? Tons of things can be displayed in the mode line, including symbols. "Displayed" does not preclude producing a string representation of the thing to be displayed. And users of this macro should not need to know intricacies of how things can be displayed in the mode line. They should be told what the type of LIGHTER is, IMO. But if you don't want to clarify this by adding one word, as in the manual, then, well, don't.