From: Andy Moreton <andrewjmoreton@gmail.com>
To: 31052@debbugs.gnu.org
Subject: bug#31052: 26.0.91; Improve documentation of inline-letevals
Date: Wed, 04 Apr 2018 14:18:32 +0100 [thread overview]
Message-ID: <vz17epn3yaf.fsf@gmail.com> (raw)
In-Reply-To: <87a7uj24kk.fsf@runbox.com>
On Wed 04 Apr 2018, Eli Zaretskii wrote:
>> From: Gemini Lasswell <gazally@runbox.com>
>> Date: Tue, 03 Apr 2018 17:33:31 -0700
>>
>> I just got acquainted with inline-letevals and found its description
>> in the Elisp manual confusing because the purpose of the macro is not
>> stated, and it is described as similar to 'let' without mention of an
>> important difference in what happens to the elements of the bindings
>> list which are symbols.
>>
>> Here's a patch to functions.texi where I've attempted to clarify the
>> description.
>
> Thanks, but your text left me confused, perhaps because it mixes the
> details of the syntax and semantics with the explanation of why and
> how to use them, and what is the result of such usage. These should
> be generally kept separate for clarity.
>
> How about if you first tell informally what information is missing
> from the original text, and then we see how to augment that by adding
> the missing bits?
The same node in the elisp manual has this:
Functions defined via ‘define-inline’ have several advantages with
respect to macros defined by ‘defsubst’ or ‘defmacro’:
and this:
− They behave in a more predictable way than ‘cl-defsubst’ (*note
(cl)Argument Lists::).
It would be more consistent to use defsubst or cl-defsubst in both
places.
Also, while looking at inline-letevals in inline.el, I noticed that the
preceeding macros inline--leteval and inline--letlisteval mention the
wrong symbol name in their error messages:
(defmacro inline--leteval (_var-exp &rest _body)
(declare (indent 1) (debug (sexp &rest body)))
(error "inline-letevals can only be used within define-inline"))
(defmacro inline--letlisteval (_list &rest _body)
(declare (indent 1) (debug (sexp &rest body)))
(error "inline-letevals can only be used within define-inline"))
Perhaps these typos can be fixed before the release.
AndyM
next prev parent reply other threads:[~2018-04-04 13:18 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-04-04 0:33 bug#31052: 26.0.91; Improve documentation of inline-letevals Gemini Lasswell
2018-04-04 6:45 ` Eli Zaretskii
2018-04-04 13:18 ` Andy Moreton [this message]
2018-04-04 14:06 ` Eli Zaretskii
2018-04-05 1:12 ` Stefan Monnier
2018-04-04 17:10 ` Gemini Lasswell
2018-04-05 9:54 ` Eli Zaretskii
2018-04-06 20:29 ` Gemini Lasswell
2020-08-22 15:59 ` Lars Ingebrigtsen
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=vz17epn3yaf.fsf@gmail.com \
--to=andrewjmoreton@gmail.com \
--cc=31052@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).