Mailing-List: contact zsh-workers-help@zsh.org; run by ezmlm
Precedence: bulk
From: Bart Schaefer <schaefer@brasslantern.com>
Message-Id: <160130114745.ZM10270@torch.brasslantern.com>
Date: Sat, 30 Jan 2016 11:47:45 -0800
In-Reply-To: <20160130074657.GA3030@tarsus.local2>
Comments: In reply to Daniel Shahaf <d.s@daniel.shahaf.name>
        "typeset docs flow Re: [PATCH] typeset: set $? on incidental error" (Jan 30,  7:46am)
References: <20160123235300.GC20278@tarsus.local2>  <56A445E0.50706@gmx.com> 
	<20160126225008.GA4731@tarsus.local2> 
	<160126201724.ZM2552@torch.brasslantern.com> 
	<20160129091834.GA8420@tarsus.local2> 
	<20160130074657.GA3030@tarsus.local2>
To: zsh-workers@zsh.org
Subject: Re: typeset docs flow Re: [PATCH] typeset: set $? on incidental error
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii

On Jan 30,  7:46am, Daniel Shahaf wrote:
} Subject: typeset docs flow Re: [PATCH] typeset: set $? on incidental error
}
} The following paragraph (the context lines of the patch) is the
} continuation of the text about var(name) that precedes the segment about
} the reserved word syntax.

How about the below?

Two other things:  (1) I still get a double blank line before any use
of example(...) -- I thought we'd come up with a fix for that (Jun T.
perhaps?).  (2) I noticed in passing that there are a lot of places
where builtins.yo says "the shell will try ..." (sometimes without the
word "try") -- if someone were up for a lot of work, this should all
be rewritten in active voice, i.e., "the shell does", not "the shell
will (do)"; and unless something useful happens when "try" does not
succeed [in which case explain it], remove the wishy-washy. 


diff --git a/Doc/Zsh/builtins.yo b/Doc/Zsh/builtins.yo
index cdf405b..365f8e1 100644
--- a/Doc/Zsh/builtins.yo
+++ b/Doc/Zsh/builtins.yo
@@ -1763,18 +1763,31 @@ ifnzman(noderef(Local Parameters))\
 retain their special attributes when made local.
 
 For each var(name)tt(=)var(value) assignment, the parameter
-var(name) is set to var(value).  All forms of the command
-handle scalar assignment.
+var(name) is set to var(value).
 
-If any of the reserved words tt(declare), tt(export), tt(float),
+If the shell option tt(TYPESET_SILENT) is not set, for each remaining
+var(name) that refers to a parameter that is already set, the name and
+value of the parameter are printed in the form of an assignment.
+Nothing is printed for newly-created parameters, or when any attribute
+flags listed below are given along with the var(name).  Using
+`tt(PLUS())' instead of minus to introduce an attribute turns it off.
+
+If no var(name) is present, the names and values of all parameters are
+printed.  In this case the attribute flags restrict the display to only
+those parameters that have the specified attributes, and using `tt(PLUS())'
+rather than `tt(-)' to introduce the flag suppresses printing of the values
+of parameters when there is no parameter name.
+
+All forms of the command handle scalar assignment.  Array assignment is
+possible if any of the reserved words tt(declare), tt(export), tt(float),
 tt(integer), tt(local), tt(readonly) or tt(typeset) is matched when the
-line is parsed (N.B. not when it is executed) the shell will try to parse
-arguments as assignments, except that the `tt(+=)' syntax and the
-tt(GLOB_ASSIGN) option are not supported.  This has two major differences
-from normal command line argument parsing: array assignment is possible,
-and scalar values after tt(=) are not split further into words even if
-expanded (regardless of the setting of the tt(KSH_TYPESET) option; this
-option is obsolete).  Here is an example:
+line is parsed (N.B. not when it is executed).  In this case the arguments
+are parsed as assignments, except that the `tt(+=)' syntax and the
+tt(GLOB_ASSIGN) option are not supported, and scalar values after tt(=)
+are em(not) split further into words, even if expanded (regardless of the
+setting of the tt(KSH_TYPESET) option; this option is obsolete).
+
+Examples of the differences between command and reserved word parsing:
 
 example(# Reserved word parsing
 typeset svar=$(echo one word) avar=(several words))
@@ -1843,19 +1856,6 @@ To initialize a parameter var(param) to a command output and mark it readonly,
 use tt(typeset -r )var(param) or tt(readonly )var(param) after the parameter
 assignment statement.
 
-If the shell option tt(TYPESET_SILENT) is not set, for each remaining
-var(name) that refers to a parameter that is already set, the name and
-value of the parameter are printed in the form of an assignment.
-Nothing is printed for newly-created parameters, or when any attribute
-flags listed below are given along with the var(name).  Using
-`tt(PLUS())' instead of minus to introduce an attribute turns it off.
-
-If no var(name) is present, the names and values of all parameters are
-printed.  In this case the attribute flags restrict the display to only
-those parameters that have the specified attributes, and using `tt(PLUS())'
-rather than `tt(-)' to introduce the flag suppresses printing of the values
-of parameters when there is no parameter name.
-
 If no attribute flags are given, and either no var(name) arguments are
 present or the flag tt(+m) is used, then each parameter name printed is
 preceded by a list of the attributes of that parameter (tt(array),