From: jkleint <jkleint@gmail.com>
Date: Fri, 25 Jan 2013 17:17:56 +0000 (-0500)
Subject: Clarify description of `as`
X-Git-Tag: jq-1.3~29^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=115552f3a6d75da79e4aef544c2a76aaee2eb01d;p=jq

Clarify description of `as`

It's more of a foreach loop than an identity operation.

Addresses issue #72.
---

diff --git a/docs/content/3.manual/manual.yml b/docs/content/3.manual/manual.yml
index de60821..d6732e6 100644
--- a/docs/content/3.manual/manual.yml
+++ b/docs/content/3.manual/manual.yml
@@ -953,10 +953,11 @@ sections:
           
               .realnames as $names | .posts[] | {title, author: $names[.author]}
           
-          The expression "foo as $x" runs foo, puts the result in $x,
-          and returns the original input. Apart from the side-effect
-          of binding the variable, it has the same effect as ".".
-          
+          The expression `exp as $x | ...` means: for each value of expression
+          `exp`, run the rest of the pipeline with the entire original input, and
+          with `$x` set to that value.  Thus `as` functions as something of a 
+          foreach loop.
+
           Variables are scoped over the rest of the expression that defines
           them, so