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

Previous Next

Package: emacs;

Reported by: Alan Mackenzie <acm <at> muc.de>

Date: Mon, 16 Jan 2017 21:24:01 UTC

Severity: wishlist

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

Bug is archived. No further changes may be made.

Full log


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

From: npostavs <at> users.sourceforge.net
To: Alan Mackenzie <acm <at> muc.de>
Cc: Michael Heerdegen <michael_heerdegen <at> web.de>, 25461 <at> debbugs.gnu.org
Subject: Re: bug#25461: [Patch #2]: Missing doc strings for "," and ",@".
Date: Mon, 23 Jan 2017 23:01:36 -0500
Alan Mackenzie <acm <at> muc.de> writes:

>
> I've hacked all this together.  What used to be called a "reader macro"
> is now a "reader construct".

I think "read syntax" is better just because the manual already uses
that term.

> +;; Give `,' and `,@' documentation strings which can be examined by C-h f.
> +(put '\, 'function-documentation
> +     "See `\\=`' (also `pcase') for the details of `,'.")
> +(put '\, 'reader-construct t)
> +
> +(put '\,@ 'function-documentation
> +     "See `\\=`' or `,' for the details of `,@'.")

Linking from ",@" to "," seems a bit unhelpful, since "," hardly says
anything and just links to "`".




This bug report was last modified 8 years and 116 days ago.

Previous Next


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