emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Minor typo in seq-let info docs


From: Nicolas Petton
Subject: Re: Minor typo in seq-let info docs
Date: Sat, 29 Aug 2015 17:38:14 +0200
User-agent: Notmuch/0.19 (http://notmuchmail.org) Emacs/25.0.50.1 (x86_64-unknown-linux-gnu)

address@hidden writes:

> This sentence re seq-let is hard to parse -- suspect an extra "in":
>
> <cite>
> -- Macro: seq-let arguments sequence body…
>      This macro binds the variables in defined in the sequence ARGUMENTS
>      to the elements of the sequence SEQUENCE.  ARGUMENTS can itself
>      include sequences allowing for nested destructuring.
>
> -- 
>
> </cite> 
>
> In addition, the somewhat self-referential nature of the opening
> sentence makes it confusing reading. That I am listening to it likely
> makes it harder -- adding some quoting in addition to case changes
> would make it easier reading.
>
> <rewrite>
> -- Macro: seq-let arguments sequence body…
>      This macro binds the variables  listed in  `ARGUMENTS'
>      to the elements of the sequence SEQUENCE.  `ARGUMENTS' can itself
>      include sequences allowing for nested destructuring.
>
> -- 

Indeed, thanks for the rewrite!

I will apply your changes (without quoting ARGUMENTS though, function
arguments should not be quoted in docstrings).

Nico
-- 
Nicolas Petton
http://nicolas-petton.fr

Attachment: signature.asc
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]