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: Thu, 4 Jul 2019 08:19:36 -0700 (PDT) Message-ID: <4dc6d6ce-351c-426a-8371-3ce170c74f1a@default> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="106231"; mail-complaints-to="usenet@blaine.gmane.org" To: 36500@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu Jul 04 17:28:41 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 1hj3f6-000RJR-Rc for geb-bug-gnu-emacs@m.gmane.org; Thu, 04 Jul 2019 17:28:40 +0200 Original-Received: from localhost ([::1]:46890 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hj3X0-0004zQ-PZ for geb-bug-gnu-emacs@m.gmane.org; Thu, 04 Jul 2019 11:20:18 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:37496) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hj3Wn-0004zH-38 for bug-gnu-emacs@gnu.org; Thu, 04 Jul 2019 11:20:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hj3Wk-00047y-UZ for bug-gnu-emacs@gnu.org; Thu, 04 Jul 2019 11:20:05 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:42909) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hj3Wk-00047q-PI for bug-gnu-emacs@gnu.org; Thu, 04 Jul 2019 11:20:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hj3Wk-0002Zw-J4 for bug-gnu-emacs@gnu.org; Thu, 04 Jul 2019 11:20: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: Thu, 04 Jul 2019 15:20:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 36500 X-GNU-PR-Package: emacs X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.15622535869880 (code B ref -1); Thu, 04 Jul 2019 15:20:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 4 Jul 2019 15:19:46 +0000 Original-Received: from localhost ([127.0.0.1]:51730 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hj3WT-0002ZI-Vr for submit@debbugs.gnu.org; Thu, 04 Jul 2019 11:19:46 -0400 Original-Received: from lists.gnu.org ([209.51.188.17]:52032) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hj3WS-0002ZB-Nv for submit@debbugs.gnu.org; Thu, 04 Jul 2019 11:19:45 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:37457) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hj3WQ-0004wX-DZ for bug-gnu-emacs@gnu.org; Thu, 04 Jul 2019 11:19:44 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hj3WP-0003sQ-4M for bug-gnu-emacs@gnu.org; Thu, 04 Jul 2019 11:19:42 -0400 Original-Received: from userp2120.oracle.com ([156.151.31.85]:38622) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1hj3WO-0003py-RH for bug-gnu-emacs@gnu.org; Thu, 04 Jul 2019 11:19:41 -0400 Original-Received: from pps.filterd (userp2120.oracle.com [127.0.0.1]) by userp2120.oracle.com (8.16.0.27/8.16.0.27) with SMTP id x64FIhZQ076946 for ; Thu, 4 Jul 2019 15:19:38 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=mime-version : message-id : date : from : sender : to : subject : content-type : content-transfer-encoding; s=corp-2018-07-02; bh=Hb6bB1onm65yOxGH4dM+yM+lH9vP+/ozn+UdQLkMEfE=; b=BE1I3Iyem5A+OrT08ufJKHOuWtG5cfD+FAHKTBS3iSm3nEAyeTFqg+kGG7K/HmjeKZro e72eqN+67V3gl7EdkfuWOEYHPEMDIfPpW5UWZdytOwWey8VZeCTzVYxP5DD6NdJOOpDC MgpIXXwzxi3jrY0gB4oXWXRczLukuBHA1PE788zUcyQdTeDYOVT0WAkPcsaabCo0gQJz 0DFiYpg/8JcLN+Ag8HkpZ+0KGNicd8fhkrev/HBBnhSDiYaHewLI0YxpvyQ3GugUGd1j 7LghiH/k1dYw0rPzH/VpHQYA/B0Yucr3dWHylwnEIHXpwzJppAK8OeJcFy1Tk/i2U2RA DA== Original-Received: from aserp3030.oracle.com (aserp3030.oracle.com [141.146.126.71]) by userp2120.oracle.com with ESMTP id 2te61q7cca-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Thu, 04 Jul 2019 15:19:38 +0000 Original-Received: from pps.filterd (aserp3030.oracle.com [127.0.0.1]) by aserp3030.oracle.com (8.16.0.27/8.16.0.27) with SMTP id x64FHejG098136 for ; Thu, 4 Jul 2019 15:19:37 GMT Original-Received: from aserv0121.oracle.com (aserv0121.oracle.com [141.146.126.235]) by aserp3030.oracle.com with ESMTP id 2th5qmbgx7-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Thu, 04 Jul 2019 15:19:37 +0000 Original-Received: from abhmp0017.oracle.com (abhmp0017.oracle.com [141.146.116.23]) by aserv0121.oracle.com (8.14.4/8.13.8) with ESMTP id x64FJaBj019702 for ; Thu, 4 Jul 2019 15:19:37 GMT 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=9307 signatures=668688 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=1 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-1907040194 X-Proofpoint-Virus-Version: vendor=nai engine=6000 definitions=9307 signatures=668688 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 priorityscore=1501 malwarescore=0 suspectscore=1 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 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-1907040194 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x [generic] 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:162062 Archived-At: Apologies if this enhancement request has been proposed before. It seems like it might have been, as it's a pretty obvious possibility. Suggestion: 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. 3. Say whether the variable is global (an option, customizable), or buffer-local. 4. Maybe mention that the variable is set/reset automatically when you toggle the mode. If the var is global mention that you can set/reset it manually using Customize. 5. Any particularities, e.g. from using `:variable' should be taken into account, so the doc string is correct for all cases. In GNU Emacs 26.2 (build 1, x86_64-w64-mingw32) of 2019-04-13 Repository revision: fd1b34bfba8f3f6298df47c8e10b61530426f749 Windowing system distributor `Microsoft Corp.', version 10.0.17134 Configured using: `configure --without-dbus --host=3Dx86_64-w64-mingw32 --without-compress-install 'CFLAGS=3D-O2 -static -g3''