unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 23130@debbugs.gnu.org
Subject: bug#23130: 25.1.50; `C-h f' etc.: escaping in symbol names
Date: Sun, 27 Mar 2016 16:25:07 -0700 (PDT)	[thread overview]
Message-ID: <5f0de05c-33e6-4855-8603-19c0bd0c4c4e@default> (raw)

(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=/c/Devel/emacs/snapshot/trunk --enable-checking=yes
 --enable-check-lisp-object-type --without-compress-install 'CFLAGS=-Og
 -ggdb3' LDFLAGS=-Lc:/Devel/emacs/lib 'CPPFLAGS=-DGC_MCHECK=1
 -Ic:/Devel/emacs/include''





             reply	other threads:[~2016-03-27 23:25 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-03-27 23:25 Drew Adams [this message]
2016-03-28  6:57 ` bug#23130: 25.1.50; `C-h f' etc.: escaping in symbol names Andreas Schwab
2016-03-28 13:21   ` Drew Adams
2016-03-28 14:26     ` Andreas Schwab
2016-03-28 14:48       ` Drew Adams
2016-03-28 15:19         ` Andreas Schwab
2016-03-28 15:23           ` Drew Adams
2016-03-28 16:11             ` Andreas Schwab
2016-03-28 17:08               ` Drew Adams
2016-03-28 17:18                 ` Andreas Schwab
2022-02-08  7:04 ` Lars Ingebrigtsen
2022-02-08  9:13   ` Andreas Schwab
2022-02-08  9:29     ` Lars Ingebrigtsen
2022-02-08  9:41       ` Andreas Schwab
2022-03-09 16:30         ` Lars Ingebrigtsen
2022-03-09 17:09           ` Andreas Schwab
2022-03-09 17:11             ` Lars Ingebrigtsen
2022-03-09 17:39               ` Andreas Schwab
2022-03-09 17:42                 ` Lars Ingebrigtsen
2022-03-14  9:23 ` Lars Ingebrigtsen
2022-03-14 14:50   ` bug#23130: [External] : " Drew Adams

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=5f0de05c-33e6-4855-8603-19c0bd0c4c4e@default \
    --to=drew.adams@oracle.com \
    --cc=23130@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).