unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Nicolas Petton <nicolas@petton.fr>
To: raman@google.com, emacs-devel@gnu.org
Subject: Re: Minor typo in seq-let info docs
Date: Sat, 29 Aug 2015 17:38:14 +0200	[thread overview]
Message-ID: <87wpwef6l5.fsf@petton.fr> (raw)
In-Reply-To: <21985.53110.605129.708969@gargle.gargle.HOWL>

[-- Attachment #1: Type: text/plain, Size: 1124 bytes --]

raman@google.com 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 #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 512 bytes --]

  reply	other threads:[~2015-08-29 15:38 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-08-29 15:27 Minor typo in seq-let info docs raman
2015-08-29 15:38 ` Nicolas Petton [this message]
2015-08-31 22:51 ` T.V Raman

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=87wpwef6l5.fsf@petton.fr \
    --to=nicolas@petton.fr \
    --cc=emacs-devel@gnu.org \
    --cc=raman@google.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).