zsh-workers
 help / color / mirror / code / Atom feed
From: Bart Schaefer <schaefer@brasslantern.com>
To: zsh-workers@zsh.org
Subject: Documenting "--" (was Re: Glob problem)
Date: Wed, 23 Oct 2013 09:01:31 -0700	[thread overview]
Message-ID: <131023090131.ZM9876@torch.brasslantern.com> (raw)
In-Reply-To: <20131023144700.43a7849a@pwslap01u.europe.root.pri>

Redirected to zsh-workers.

On Oct 23,  2:47pm, Peter Stephenson wrote:
}
} Some of the regulars can tell me if the following looks right.

Apologies if the following is too nit-picky ...

} +Some shell builtin commands take options as given in invidiual entries.

Am I correct in understanding "given" here to mean "described"?  If so,
just say "described".

} +Some shell builtin commands also take options that begin with `tt(+)'
} +instead of `tt(-)'.  These commands are indicated in the list below.

The word "indicated" here makes me expect something similar to the <S>
and <Z> markings in the options list, which obviously isn't what you
mean.

} +Options must appear in a group before any non-option arguments;

"Options (and their individual arguments, if any) ..." ?  Also the whole
document could probably use a consistency check, because sometimes we
use the term "flags" to differentiate command options from setopts, and
other times we don't.  Maybe it would suffice to point out that "flags"
and "options" are the same thing and we use flags when there would be
confusion (such as when describing the "-o option" flag of "emulate").

Otherwise this all looks accurate.


       reply	other threads:[~2013-10-23 16:02 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <65DB21EB-86B6-479C-8F25-35B9B832CFD5@gmail.com>
     [not found] ` <5266BFF6.4050004@oracle.com>
     [not found]   ` <F450529B-46FF-4267-B1A3-01E291221268@gmail.com>
     [not found]     ` <20131023.051117.47078782.ghostrevery@gmail.com>
     [not found]       ` <91F9ED9F-B198-403B-9FE1-FF40DE960C1C@gmail.com>
     [not found]         ` <20131023144700.43a7849a@pwslap01u.europe.root.pri>
2013-10-23 16:01           ` Bart Schaefer [this message]
2013-10-23 16:16             ` Peter Stephenson
2013-10-23 16:56               ` Bart Schaefer

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=131023090131.ZM9876@torch.brasslantern.com \
    --to=schaefer@brasslantern.com \
    --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).