GNU bug report logs - #25461
Missing doc strings for "," and ",@".

Previous Next

Full log

Message #23 received at 25461 <at> debbugs.gnu.org (full text, mbox):

From: Michael Heerdegen <michael_heerdegen <at> web.de>
To: Alan Mackenzie <acm <at> muc.de>
Cc: Andreas Schwab <schwab <at> linux-m68k.org>, 25461 <at> debbugs.gnu.org
Subject: Re: bug#25461: Missing doc strings for "," and ",@".
Date: Wed, 18 Jan 2017 02:44:28 +0100

Alan Mackenzie <acm <at> muc.de> writes:

> I don't expect the typical novice Elisp hacker cares about such nice
> distinctions.  She can get a doc string for `, so why not one for , or
> ,@?

' and #' also "don't have a docstring".  That ` "has a docstring" is
just coincidence - because the reader transforms

  `expr

to

  (` expr)

and the symbol ` has an associated symbol-function.

FWIW when I first saw `, , and ,@, it looked strange enough to me to
open the manual, because the syntax seemed so unusual that I believed
that I missed an essential part of knowledge about Elisp.  At least this
is what I think happened...

But I agree that some people might try C-h f on any of these, and we
would not all die if we would show something useful in this case.  We
could just say that C-f explains symbol functions and "reader macros"
and the thing would still be consistent.

OTOH, I think that saying anything about `pcase' there would be a bad
idea.


Michael.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.