]> granicus.if.org Git - jq/commitdiff
Clarify description of `as` 77/head
authorjkleint <jkleint@gmail.com>
Fri, 25 Jan 2013 17:17:56 +0000 (12:17 -0500)
committerjkleint <jkleint@gmail.com>
Fri, 25 Jan 2013 17:17:56 +0000 (12:17 -0500)
It's more of a foreach loop than an identity operation.

Addresses issue #72.

docs/content/3.manual/manual.yml

index de6082105ac25dc42513374c79c16edbbd84c369..d6732e68894fee864df7ceea20cb13727145b189 100644 (file)
@@ -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