From: "Basil L. Contovounesios" <contovob@tcd.ie>
To: Lars Ingebrigtsen <larsi@gnus.org>
Cc: 34842@debbugs.gnu.org, "Sebastián Monía" <seb.hoagie@outlook.com>
Subject: bug#34842: 26.1; Alist documentation: let-alist
Date: Sun, 13 Oct 2019 13:17:51 +0100 [thread overview]
Message-ID: <87y2xoj0uo.fsf@tcd.ie> (raw)
In-Reply-To: <87a7a5e4yc.fsf@gnus.org> (Lars Ingebrigtsen's message of "Sun, 13 Oct 2019 04:48:11 +0200")
Lars Ingebrigtsen <larsi@gnus.org> writes:
> "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:
Thanks.
>> +@samp{.} are bound. Each such @var{.symbol} is bound to the @sc{cdr}
>> +of the first association for @var{symbol} in @var{alist} using
>> +@code{assq}. If no such association exists, @var{.symbol} is bound to
>> +@code{nil}:
>>
>> +@lisp
>> +(let-alist colors
>> + .tulip)
>> + @result{} nil
>> +@end lisp
>
> This bit seems superfluous. (cdr (assq ...)) is nil when no such
> association exists, but this makes it sound like that's a special case
> somehow...
It's just making it explicit without having to refer to specifics of the
implementation. I think it's a common style in the docs, but I don't
feel strongly about it. Would you rather remove the example, the
sentence, or both?
--
Basil
next prev parent reply other threads:[~2019-10-13 12:17 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
2019-10-13 13:15 ` Eli Zaretskii
2019-10-13 12:17 ` Basil L. Contovounesios [this message]
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87y2xoj0uo.fsf@tcd.ie \
--to=contovob@tcd.ie \
--cc=34842@debbugs.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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.