From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: =?UTF-8?Q?=E7=A9=8D=E4=B8=B9=E5=B0=BC?= Dan Jacobson Newsgroups: gmane.emacs.bugs Subject: bug#38601: describe-mode never says the most important thing Date: Sat, 14 Dec 2019 07:29:31 +0800 Message-ID: <87d0crpzxg.5.fsf@jidanni.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="261494"; mail-complaints-to="usenet@blaine.gmane.org" To: 38601@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Dec 14 02:22:11 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 1ifw8H-0015t2-Tk for geb-bug-gnu-emacs@m.gmane.org; Sat, 14 Dec 2019 02:22:10 +0100 Original-Received: from localhost ([::1]:54910 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ifw8G-0003At-RB for geb-bug-gnu-emacs@m.gmane.org; Fri, 13 Dec 2019 20:22:08 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:44984) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ifw8B-0003Al-Az for bug-gnu-emacs@gnu.org; Fri, 13 Dec 2019 20:22:04 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ifw8A-0003Vz-6k for bug-gnu-emacs@gnu.org; Fri, 13 Dec 2019 20:22:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:57032) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1ifw8A-0003Uw-19 for bug-gnu-emacs@gnu.org; Fri, 13 Dec 2019 20:22:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1ifw89-0000HM-Sk for bug-gnu-emacs@gnu.org; Fri, 13 Dec 2019 20:22:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: =?UTF-8?Q?=E7=A9=8D=E4=B8=B9=E5=B0=BC?= Dan Jacobson Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 14 Dec 2019 01:22:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 38601 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.15762864981036 (code B ref -1); Sat, 14 Dec 2019 01:22:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 14 Dec 2019 01:21:38 +0000 Original-Received: from localhost ([127.0.0.1]:34772 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ifw7l-0000Ge-Lj for submit@debbugs.gnu.org; Fri, 13 Dec 2019 20:21:37 -0500 Original-Received: from lists.gnu.org ([209.51.188.17]:57720) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ifw7j-0000GU-SL for submit@debbugs.gnu.org; Fri, 13 Dec 2019 20:21:36 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:37913) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ifw7i-0002mL-Ia for bug-gnu-emacs@gnu.org; Fri, 13 Dec 2019 20:21:35 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ifw7h-0002FL-3n for bug-gnu-emacs@gnu.org; Fri, 13 Dec 2019 20:21:34 -0500 Original-Received: from fossa.birch.relay.mailchannels.net ([23.83.209.62]:20313) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1ifw7g-00025y-MM for bug-gnu-emacs@gnu.org; Fri, 13 Dec 2019 20:21:33 -0500 X-Sender-Id: dreamhost|x-authsender|jidanni@jidanni.org Original-Received: from relay.mailchannels.net (localhost [127.0.0.1]) by relay.mailchannels.net (Postfix) with ESMTP id B9B1B5A1010 for ; Sat, 14 Dec 2019 01:21:29 +0000 (UTC) Original-Received: from pdx1-sub0-mail-a100.g.dreamhost.com (100-96-169-214.trex.outbound.svc.cluster.local [100.96.169.214]) (Authenticated sender: dreamhost) by relay.mailchannels.net (Postfix) with ESMTPA id 3DFC45A0FBD for ; Sat, 14 Dec 2019 01:21:29 +0000 (UTC) X-Sender-Id: dreamhost|x-authsender|jidanni@jidanni.org Original-Received: from pdx1-sub0-mail-a100.g.dreamhost.com ([TEMPUNAVAIL]. [64.90.62.162]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384) by 0.0.0.0:2500 (trex/5.18.5); Sat, 14 Dec 2019 01:21:29 +0000 X-MC-Relay: Neutral X-MailChannels-SenderId: dreamhost|x-authsender|jidanni@jidanni.org X-MailChannels-Auth-Id: dreamhost X-Lyrical-Wipe: 73319b70255e7f8c_1576286489531_1946078738 X-MC-Loop-Signature: 1576286489531:1660820161 X-MC-Ingress-Time: 1576286489530 Original-Received: from pdx1-sub0-mail-a100.g.dreamhost.com (localhost [127.0.0.1]) by pdx1-sub0-mail-a100.g.dreamhost.com (Postfix) with ESMTP id 11D1D7F53E for ; Fri, 13 Dec 2019 17:21:26 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha1; c=relaxed; d=jidanni.org; h=from:to :subject:date:message-id:mime-version:content-type :content-transfer-encoding; s=jidanni.org; bh=XWlQMsvfLqOHckqHgO UWvaOuhgw=; b=ijV/J3wbIL3xHBs0tfCCK7SYNW23jmYIA165wofaAKFXinRgyW 8zUUCeisDfGQs4CY2W+PCEXVGZ+mOO+Mas0xrHd6KofLlMkRbx9XiBTnxVzq99a6 KC+KZA1qOiT49RhJQ/R+3Zghs2J7FnewkKArYqjqA+mCr1K8/D9wdxGGc= Original-Received: from jidanni.org (114-26-40-245.dynamic-ip.hinet.net [114.26.40.245]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) (Authenticated sender: jidanni@jidanni.org) by pdx1-sub0-mail-a100.g.dreamhost.com (Postfix) with ESMTPSA id 699377F661 for ; Fri, 13 Dec 2019 17:21:25 -0800 (PST) X-DH-BACKEND: pdx1-sub0-mail-a100 X-VR-OUT-STATUS: OK X-VR-OUT-SCORE: 0 X-VR-OUT-SPAMCAUSE: gggruggvucftvghtrhhoucdtuddrgedufedrvddttddgfeefucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuggftfghnshhusghstghrihgsvgdpffftgfetoffjqffuvfenuceurghilhhouhhtmecufedttdenucenucfjughrpefhvffufffkgggtgfesthekredttddtjeenucfhrhhomhepnjjnnjcuffgrnhculfgrtghosghsohhnuceojhhiuggrnhhnihesjhhiuggrnhhnihdrohhrgheqnecukfhppeduudegrddviedrgedtrddvgeehnecurfgrrhgrmhepmhhouggvpehsmhhtphdphhgvlhhopehjihgurghnnhhirdhorhhgpdhinhgvthepuddugedrvdeirdegtddrvdeghedprhgvthhurhhnqdhprghthheppeeruhhtfhdqkeerueerheeimhfphefnihehhegsveekreepucffrghnucflrggtohgsshhonhcuoehjihgurghnnhhisehjihgurghnnhhirdhorhhgqedpmhgrihhlfhhrohhmpehjihgurghnnhhisehjihgurghnnhhirdhorhhgpdhnrhgtphhtthhopegsuhhgqdhgnhhuqdgvmhgrtghssehgnhhurdhorhhgnecuvehluhhsthgvrhfuihiivgeptd X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] 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:173295 Archived-At: C-h m runs the command describe-mode And it has problems. Let's take a look at a typical section of the describe-mode output: ^L Electric-Indent minor mode (no indicator): Toggle on-the-fly reindentation (Electric Indent mode). With a prefix argument ARG, enable Electric Indent mode if ARG is positive, and disable it otherwise. If called from Lisp, enable the mode if ARG is omitted or nil. When enabled, this reindents whenever the hook =E2=80=98electric-indent= -functions=E2=80=99 returns non-nil, or if you insert a character from =E2=80=98electric-in= dent-chars=E2=80=99. This is a global minor mode. To toggle the mode in a single buffer, use =E2=80=98electric-indent-local-mode=E2=80=99. ^L The problem is, it doesn't mention how to turn it on and off! The user has to click on each line right after an ^L, to learn that he simply needs to do e.g., (electric-indent-mode &optional ARG) That's right, each section between the ^L's could go on for miles and miles, never revealing the most important thing: how to turn it on and off. Well OK, at the top say "to avoid cluttering the page, please click each item to learn how to turn it on and off". (Or "how to invoke.") P.S., some of the entries are followed by a mysterious (fn &optional ARG) and some of them aren't. ^L Auto-Compression minor mode (no indicator): Toggle Auto Compression mode. With a prefix argument ARG, enable Auto Compression mode if ARG is positive, and disable it otherwise. If called from Lisp, enable the mode if ARG is omitted or nil. Auto Compression mode is a global minor mode. When enabled, compressed files are automatically uncompressed for reading, and compressed when writing. ^L Auto-Encryption minor mode (no indicator): Toggle automatic file encryption/decryption (Auto Encryption mode). With a prefix argument ARG, enable Auto Encryption mode if ARG is positive, and disable it otherwise. If called from Lisp, enable the mode if ARG is omitted or nil. (fn &optional ARG) ^L Perhaps fn stands for the function name, but the page never says what the exact function name is. So we end up having to look it up anyway. Also there is no rhyme or reason why we only see it on some entries. emacs-version "26.3"