From: Nathanael Schweers <NSchweers+emacs-help@mailbox.org>
To: help-gnu-emacs@gnu.org
Subject: Referencing variables beginning with an asterisk in docstrings broken?
Date: Thu, 25 Aug 2016 16:54:25 +0200 [thread overview]
Message-ID: <87twe8gaqm.fsf@reisefreund.localdomain> (raw)
I wanted to include a reference to a global (dynamic) variable in one of
my docstrings. According to the info page “(elisp) Documentation Tips”
one merely has to reference the variable in question between the
quotation marks ‘ and ’.
As far as I can tell so far, this works, as long as the variable does
not start with an asterisk. I.e. ‘varname’ works, so does ‘varname*’,
yet not ‘*varname’. Hence, ‘*varname*’ also does not work.
I’d like to adhere to the Common Lisp convention of naming special
variables in my elisp code, yet if I do so, I cannot seem to reference
them in docstrings.
Is this behaviour a bug?
Best Regards,
Nathanael Schweers
--
next reply other threads:[~2016-08-25 14:54 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-08-25 14:54 Nathanael Schweers [this message]
2016-08-28 1:55 ` Referencing variables beginning with an asterisk in docstrings broken? Stefan Monnier
2016-08-28 15:18 ` GDB GUD Variable Buffer Augusto Fraga Giachero
2016-08-28 15:53 ` Eli Zaretskii
2016-08-28 16:35 ` Augusto Fraga Giachero
2016-08-28 16:54 ` Eli Zaretskii
2016-08-28 23:32 ` Referencing variables beginning with an asterisk in docstrings broken? Nathanael Schweers
2016-08-29 0:32 ` Stefan Monnier
-- strict thread matches above, loose matches on Subject: below --
2016-08-25 13:56 Nathanael Schweers
2016-08-25 20:19 ` 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=87twe8gaqm.fsf@reisefreund.localdomain \
--to=nschweers+emacs-help@mailbox.org \
--cc=help-gnu-emacs@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.
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).