From 114ac721692ff8c89ab487d22953c3c5feabca9b Mon Sep 17 00:00:00 2001 From: Janne Cederberg Date: Sun, 10 Apr 2016 08:34:44 +0300 Subject: [PATCH] Documentation clarification suggestions --- docs/content/3.manual/manual.yml | 8 ++++---- docs/content/3.manual/v1.5/manual.yml | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/content/3.manual/manual.yml b/docs/content/3.manual/manual.yml index 3e43cdb..4dd9d3a 100644 --- a/docs/content/3.manual/manual.yml +++ b/docs/content/3.manual/manual.yml @@ -723,7 +723,7 @@ sections: - title: "`in`" body: | - The builtin function `in` returns the input key is in the + The builtin function `in` returns whether or not the input key is in the given object, or the input index corresponds to an element in the given array. It is, essentially, an inversed version of `has`. @@ -740,7 +740,7 @@ sections: body: | For any filter `x`, `map(x)` will run that filter for each - element of the input array, and produce the outputs a new + element of the input array, and return the outputs in a new array. `map(.+1)` will increment each element of an array of numbers. Similarly, `map_values(x)` will run that filter for each element, @@ -762,8 +762,8 @@ sections: body: | Outputs array representations of the given path expression - in `.`. The outputs are arrays of strings (keys in objects0 - and/or numbers (array indices. + in `.`. The outputs are arrays of strings (object keys) + and/or numbers (array indices). Path expressions are jq expressions like `.a`, but also `.[]`. There are two types of path expressions: ones that can match diff --git a/docs/content/3.manual/v1.5/manual.yml b/docs/content/3.manual/v1.5/manual.yml index 1b37e79..647048b 100644 --- a/docs/content/3.manual/v1.5/manual.yml +++ b/docs/content/3.manual/v1.5/manual.yml @@ -711,7 +711,7 @@ sections: - title: "`in`" body: | - The builtin function `in` returns the input key is in the + The builtin function `in` returns whether or not the input key is in the given object, or the input index corresponds to an element in the given array. It is, essentially, an inversed version of `has`. @@ -728,8 +728,8 @@ sections: body: | Outputs array representations of the given path expression - in `.`. The outputs are arrays of strings (keys in objects0 - and/or numbers (array indices. + in `.`. The outputs are arrays of strings (object keys) + and/or numbers (array indices). Path expressions are jq expressions like `.a`, but also `.[]`. There are two types of path expressions: ones that can match @@ -866,7 +866,7 @@ sections: body: | For any filter `x`, `map(x)` will run that filter for each - element of the input array, and produce the outputs a new + element of the input array, and return the outputs in a new array. `map(.+1)` will increment each element of an array of numbers. Similarly, `map_values(x)` will run that filter for each element, -- 2.40.0