From: Daniel Shahaf <d.s@daniel.shahaf.name>
To: zsh-workers@zsh.org
Subject: Re: [PATCH] coding practice in examples (-- with globs mostly)
Date: Wed, 1 Jan 2020 12:52:13 +0000 [thread overview]
Message-ID: <20200101125213.fo75ca2wdkwrbzi4@tarpaulin.shahaf.local2> (raw)
In-Reply-To: <20200101120009.24l375svthztyszj@chaz.gmail.com>
Stephane Chazelas wrote on Wed, Jan 01, 2020 at 12:00:09 +0000:
> 2019-12-31 17:16:38 +0000, Daniel Shahaf:
> [...]
> > > {+++ b/Doc/Zsh/contrib.yo+}
> > > @@ -4422,10 +4422,11 @@ For example, to get a long tt(ls) listing of all plain files in the
> > > current directory or its subdirectories:
> > >
> > > example(autoload -U zargs
> > > zargs -- **/*(.) -- ls [--l)-] {+-ld --)+}
> > >
> > > Note that `tt(-)tt(-)' is used both to mark the end of the var(option)
> > > list and to mark the end of the var(input) [-list,-] {+list (and here also to mark
> > > the end of the option list for tt(ls)),+} so it must appear twice
> > > whenever the var(input) list may be empty. If there is guaranteed to be
> > > at least one var(input) and the first var(input) does not begin with a
> > > `tt(-)', then the first `tt(-)tt(-)' may be omitted.
> >
> > I think the text could be a little hard to follow, since there are three
> > «--» but it talks about "both" and then mentions the third in an
> > afterthought. Would you prefer to change the incumbent text as well?
> > You're not limited to adding parentheticals.
>
> I see what you mean. How about something like:
>
> zargs -- **/*(.) -- ls -ld --
>
> The first and third occurrences of -- are used to mark the end
> of options for zargs and ls respectively to guard against
> filenames starting with -, while the second is used to separate
> the list of files from the command to run.
>
> The first -- would also be needed if there was a chance the list
> might be empty as in:
>
> zargs -r -- ./*.back(#qN) -- rm -f
Looks good, thanks. Please commit.
Further suggestions (nice-to-have's, not blockers):
- Clarify that the third -- isn't syntactically significant, and is just passed
to ls verbatim.
- Use an example with two --'s before an example with three --'s.
Cheers,
Daniel
next prev parent reply other threads:[~2020-01-01 12:53 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-12-31 9:16 Stephane Chazelas
2019-12-31 17:16 ` Daniel Shahaf
2020-01-01 12:00 ` Stephane Chazelas
2020-01-01 12:52 ` Daniel Shahaf [this message]
2020-01-01 21:18 ` [PATCH v2] " Stephane Chazelas
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=20200101125213.fo75ca2wdkwrbzi4@tarpaulin.shahaf.local2 \
--to=d.s@daniel.shahaf.name \
--cc=zsh-workers@zsh.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.vuxu.org/mirror/zsh/
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 NNTP newsgroup(s).