From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#36500: 26.2; Minor mode doc strings - say what the current mode-variable value is Date: Mon, 8 Jul 2019 14:26:52 -0700 (PDT) Message-ID: <33fe31aa-ffe3-485d-bdf6-37f371877c2f@default> References: <4dc6d6ce-351c-426a-8371-3ce170c74f1a@default> <87ef302r8f.fsf@mouse.gnus.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="49866"; mail-complaints-to="usenet@blaine.gmane.org" Cc: 36500@debbugs.gnu.org To: Lars Ingebrigtsen Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Jul 08 23:43:54 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1hkbQQ-000CZm-2u for geb-bug-gnu-emacs@m.gmane.org; Mon, 08 Jul 2019 23:43:54 +0200 Original-Received: from localhost ([::1]:44866 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hkbBd-0000ML-9k for geb-bug-gnu-emacs@m.gmane.org; Mon, 08 Jul 2019 17:28:37 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:35919) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hkbBJ-0000HB-Oh for bug-gnu-emacs@gnu.org; Mon, 08 Jul 2019 17:28:18 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hkbBG-0003Rk-K5 for bug-gnu-emacs@gnu.org; Mon, 08 Jul 2019 17:28:16 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:50916) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hkbB4-0003Lv-II for bug-gnu-emacs@gnu.org; Mon, 08 Jul 2019 17:28:05 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hkbB4-0006eN-Ab for bug-gnu-emacs@gnu.org; Mon, 08 Jul 2019 17:28:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 08 Jul 2019 21:28:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 36500 X-GNU-PR-Package: emacs Original-Received: via spool by 36500-submit@debbugs.gnu.org id=B36500.156262122325485 (code B ref 36500); Mon, 08 Jul 2019 21:28:02 +0000 Original-Received: (at 36500) by debbugs.gnu.org; 8 Jul 2019 21:27:03 +0000 Original-Received: from localhost ([127.0.0.1]:59734 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hkbA7-0006cz-CI for submit@debbugs.gnu.org; Mon, 08 Jul 2019 17:27:03 -0400 Original-Received: from userp2130.oracle.com ([156.151.31.86]:47056) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hkbA5-0006cV-5S for 36500@debbugs.gnu.org; Mon, 08 Jul 2019 17:27:01 -0400 Original-Received: from pps.filterd (userp2130.oracle.com [127.0.0.1]) by userp2130.oracle.com (8.16.0.27/8.16.0.27) with SMTP id x68LNxon154390; Mon, 8 Jul 2019 21:26:55 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=mime-version : message-id : date : from : sender : to : cc : subject : references : in-reply-to : content-type : content-transfer-encoding; s=corp-2018-07-02; bh=fwaBrs4RSXWuOeN4fHzffeCYfI3MjqECkcgwrVyhCEE=; b=W2e4WZV+p8iBunZQu6+KwDhPN653BzxKQkTLknd4qwpcIrc+j05+UvlCGefImBCpzgRL pVme2olgJopro/XcTjYkJyh73CQWLvBa5TWV7UxGGsVV/Z6DDqJ+f5YqTK3bL/ChYHMJ WqVU0xZGYvazVWIxKEUpwD7c1dLw5X32Vz1d1iVmFLkSw9TIRSFNlqkNdspgK7CwjlO5 91a1dUFFIJdgWrCoq7WSC3ZOqutSVzELwB96bqiY0BShJ2tMZs044GX/YlaRLjUHpaQg ZKwGf0a9UM/yDufF+8o0gs89COlgD3g8LceH/hb73HnICcxO/BrxlhwPF9/A+ZsFSh/W 7Q== Original-Received: from userp3020.oracle.com (userp3020.oracle.com [156.151.31.79]) by userp2130.oracle.com with ESMTP id 2tjk2tgu9d-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Mon, 08 Jul 2019 21:26:54 +0000 Original-Received: from pps.filterd (userp3020.oracle.com [127.0.0.1]) by userp3020.oracle.com (8.16.0.27/8.16.0.27) with SMTP id x68LNIdr013041; Mon, 8 Jul 2019 21:26:54 GMT Original-Received: from userv0122.oracle.com (userv0122.oracle.com [156.151.31.75]) by userp3020.oracle.com with ESMTP id 2tjjyke7jf-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Mon, 08 Jul 2019 21:26:54 +0000 Original-Received: from abhmp0009.oracle.com (abhmp0009.oracle.com [141.146.116.15]) by userv0122.oracle.com (8.14.4/8.14.4) with ESMTP id x68LQrf2008267; Mon, 8 Jul 2019 21:26:53 GMT In-Reply-To: <87ef302r8f.fsf@mouse.gnus.org> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4861.0 (x86)] X-Proofpoint-Virus-Version: vendor=nai engine=6000 definitions=9312 signatures=668688 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=0 malwarescore=0 phishscore=0 bulkscore=0 spamscore=0 mlxscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1907080267 X-Proofpoint-Virus-Version: vendor=nai engine=6000 definitions=9312 signatures=668688 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1011 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1907080267 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: 209.51.188.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" Xref: news.gmane.org gmane.emacs.bugs:162375 Archived-At: > > Have the automatically provided part of a minor-mode doc string, from > > `define-minor-mode' do the following (or at least some of it): > > > > 1. Mention the mode variable (typically the same name as the mode, > > but in any case the name is known to `define-minor-mode'). > > (The doc string currently mentions the keymap, but not the var.) > > > > 2. Show the current value of the variable, just as we do for the keymap= . > > If undefined so far then say so, just as we do for the keymap. >=20 > Here's the current output from a random minor mode defined by that > function:... > No mention of a keymap? Sorry, but I don't recall which minor-mode help I was looking at the day I filed that bug (shoulda noted the function name). But the mode was defined by `define-minor-mode', and the help had a sentence saying that (minor-map) keymap such-and-such was not yet defined. The map variable was mentioned and its value was described, at least that far. In any case, #1 and #2 here are about the mode variable, not the keymap variable. > > 3. Say whether the variable is global (an option, customizable), or > > buffer-local. >=20 > Yes, that makes sense. Currently a number of these modes say so > themselves, so that should also be adjusted: Right. Many mode doc strings provide info that is not provided, or was not provided at one point, by `define-minor-mode'.