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#23130: 25.1.50; `C-h f' etc.: escaping in symbol names Date: Sun, 27 Mar 2016 16:25:07 -0700 (PDT) Message-ID: <5f0de05c-33e6-4855-8603-19c0bd0c4c4e@default> 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 1459121192 9194 80.91.229.3 (27 Mar 2016 23:26:32 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 27 Mar 2016 23:26:32 +0000 (UTC) To: 23130@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Mar 28 01:26:18 2016 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 1akK4Q-0007Xf-Tn for geb-bug-gnu-emacs@m.gmane.org; Mon, 28 Mar 2016 01:26:11 +0200 Original-Received: from localhost ([::1]:37765 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1akK4P-00011R-VD for geb-bug-gnu-emacs@m.gmane.org; Sun, 27 Mar 2016 19:26:09 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:58804) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1akK4M-0000yB-5q for bug-gnu-emacs@gnu.org; Sun, 27 Mar 2016 19:26:07 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1akK4I-0008JH-VA for bug-gnu-emacs@gnu.org; Sun, 27 Mar 2016 19:26:06 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:43384) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1akK4I-0008JD-SF for bug-gnu-emacs@gnu.org; Sun, 27 Mar 2016 19:26:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1akK4I-0000Nr-Lb for bug-gnu-emacs@gnu.org; Sun, 27 Mar 2016 19:26: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: Sun, 27 Mar 2016 23:26:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 23130 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.14591211231421 (code B ref -1); Sun, 27 Mar 2016 23:26:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 27 Mar 2016 23:25:23 +0000 Original-Received: from localhost ([127.0.0.1]:40511 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1akK3f-0000Mr-0m for submit@debbugs.gnu.org; Sun, 27 Mar 2016 19:25:23 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:39454) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1akK3d-0000Md-8c for submit@debbugs.gnu.org; Sun, 27 Mar 2016 19:25:21 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1akK3W-0008F1-Of for submit@debbugs.gnu.org; Sun, 27 Mar 2016 19:25:15 -0400 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:41529) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1akK3W-0008Ex-Ln for submit@debbugs.gnu.org; Sun, 27 Mar 2016 19:25:14 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:58652) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1akK3V-0000th-Kd for bug-gnu-emacs@gnu.org; Sun, 27 Mar 2016 19:25:14 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1akK3S-0008EM-Cz for bug-gnu-emacs@gnu.org; Sun, 27 Mar 2016 19:25:13 -0400 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:19205) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1akK3S-0008ED-6r for bug-gnu-emacs@gnu.org; Sun, 27 Mar 2016 19:25:10 -0400 Original-Received: from userv0021.oracle.com (userv0021.oracle.com [156.151.31.71]) by aserp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id u2RNP8Rt023253 (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Sun, 27 Mar 2016 23:25:09 GMT Original-Received: from userv0121.oracle.com (userv0121.oracle.com [156.151.31.72]) by userv0021.oracle.com (8.13.8/8.13.8) with ESMTP id u2RNP8OF008100 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Sun, 27 Mar 2016 23:25:08 GMT Original-Received: from abhmp0013.oracle.com (abhmp0013.oracle.com [141.146.116.19]) by userv0121.oracle.com (8.13.8/8.13.8) with ESMTP id u2RNP87o024455 for ; Sun, 27 Mar 2016 23:25:08 GMT X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9 (901082) [OL 12.0.6744.5000 (x86)] X-Source-IP: userv0021.oracle.com [156.151.31.71] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x 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:115617 Archived-At: (defun foo. () (message "FOOOOOO")) Put point somewhere on the name `foo.'. `C-h f' You see this message: Describe function (default foo.): ^^^^ Hit `RET'. You see this output in *Help*: foo\. is a Lisp function. (foo\.) Not sure what others might think of this. The name of the symbol is "foo.", not "foo\.". This is correctly reflected in the prompt. I'm thinking it should also be reflected in the first line of the *Help* output: "foo. is a Lisp function." Or better yet, to remove all ambiguity, even for characters such as SPC in the function name, enclose the name in `...': (defun bar\ () (message "BARRRR")) `C-h f' Describe function (default bar ): RET bar\ is a Lisp function. (bar\ ) Note that the first line here is not even correct - it should at least have another SPC char after the `\ '. The way it is written now, it suggests that the name is `bar\', i.e., that the symbol is bar\\. I think it would be better to show something like this: `foo.' is a Lisp function. (foo\.) `bar ' is a Lisp function. (bar\ ) And it would be better to use `...' also in the prompt: Describe function (default `foo.'): Describe function (default `bar '): The same thing holds for other help commands (`describe-variable', `describe-mode', `describe-face', etc.). The first line of help output gives the symbol's name. At least it should be enclosed in `...'. And perhaps when the name is indicated, as opposed to the symbol itself, such chars should not be escaped. In GNU Emacs 25.1.50.1 (i686-pc-mingw32) of 2015-12-10 Repository revision: 6148555ee5a3d0139ae517803718b3e0357933c7 Windowing system distributor 'Microsoft Corp.', version 6.1.7601 Configured using: 'configure --prefix=3D/c/Devel/emacs/snapshot/trunk --enable-checking=3Dye= s --enable-check-lisp-object-type --without-compress-install 'CFLAGS=3D-Og -ggdb3' LDFLAGS=3D-Lc:/Devel/emacs/lib 'CPPFLAGS=3D-DGC_MCHECK=3D1 -Ic:/Devel/emacs/include''