unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: "Basil L. Contovounesios" <contovob@tcd.ie>
To: Eli Zaretskii <eliz@gnu.org>
Cc: Lars Ingebrigtsen <larsi@gnus.org>,
	34842@debbugs.gnu.org, seb.hoagie@outlook.com
Subject: bug#34842: 26.1; Alist documentation: let-alist
Date: Sun, 13 Oct 2019 13:38:09 +0100	[thread overview]
Message-ID: <87lftohlce.fsf@tcd.ie> (raw)
In-Reply-To: <83wod9kten.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 13 Oct 2019 10:15:44 +0300")

Eli Zaretskii <eliz@gnu.org> writes:

>> From: Lars Ingebrigtsen <larsi@gnus.org>
>> Date: Sun, 13 Oct 2019 04:48:11 +0200
>> Cc: 34842@debbugs.gnu.org, Sebastián Monía
>>  <seb.hoagie@outlook.com>
>> 
>> "Basil L. Contovounesios" <contovob@tcd.ie> writes:
>> 
>> > Thanks.  The following constitute what I think are some opportunities
>> > for clarifying the current doc.  WDYT?
>> 
>> Looks good to me, but:
>
> I have one more nit: why was @dots{} added after @var{body} in the
> @defmac line?  There's only one body here, isn't it?

There's only one body indeed, but it comprises multiple forms.
The Elisp manual currently contains over 50 occurrences of body...,
including the following:

 -- Macro: dolist (var list [result]) body...
 -- Special Form: catch tag body...
 -- Macro: ignore-errors body...
 -- Macro: defun name args [doc] [declare] [interactive] body...
 -- Macro: lambda args [doc] [interactive] body...
 -- Macro: defsubst name args [doc] [declare] [interactive] body...     
 -- Macro: defmacro name args [doc] [declare] body...
 -- Macro: with-eval-after-load library body...
 -- Special Form: eval-when-compile body...

Whereas it only contains 7 occurrences of '&rest body':

 -- Macro: pcase-defmacro name args [doc] &rest body
 -- Macro: with-connection-local-variables &rest body
 -- Macro: gv-define-setter name arglist &rest body
 -- Macro: gv-letplace (getter setter) place &rest body
 -- Macro: minibuffer-with-setup-hook function &rest body
 -- Macro: with-coding-priority coding-systems &rest body...
 -- Macro: with-temp-message message &rest body

[Note that with-coding-priority uses both &rest and body...]

And let-alist is the only occurrence of a body without either &rest or
an ellipsis:

 -- Macro: let-alist alist body

Of course there is also the forms... style, of which there are under 20
occurrences, including:

 -- Special Form: progn forms...
 -- Special Form: if condition then-form else-forms...
 -- Macro: when condition then-forms...
 -- Macro: unless condition forms...
 -- Special Form: while condition forms...
 -- Special Form: let (bindings...) forms...

I don't mind which style is preferred, but let-alist should probably
pick one of the existing ones, right?  Any preference?

Thanks,

-- 
Basil





  reply	other threads:[~2019-10-13 12:38 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-13 14:16 bug#34842: 26.1; Alist documentation: let-alist Sebastián Monía
2019-03-13 15:16 ` Drew Adams
2019-03-13 16:30   ` Sebastián Monía
2019-03-13 17:51     ` Drew Adams
2019-03-14  4:47       ` Sebastián Monía
2019-10-12 23:32 ` Lars Ingebrigtsen
2019-10-13  2:03   ` Basil L. Contovounesios
2019-10-13  2:48     ` Lars Ingebrigtsen
2019-10-13  7:15       ` Eli Zaretskii
2019-10-13 12:38         ` Basil L. Contovounesios [this message]
2019-10-13 13:15           ` Eli Zaretskii
2019-10-13 12:17       ` Basil L. Contovounesios
2019-10-13 17:39         ` 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=87lftohlce.fsf@tcd.ie \
    --to=contovob@tcd.ie \
    --cc=34842@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    --cc=larsi@gnus.org \
    --cc=seb.hoagie@outlook.com \
    /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).