From 3e795d020de54b30a79edaba68d9a8fbb23e2a0b Mon Sep 17 00:00:00 2001 From: Mike Farah Date: Sun, 13 Nov 2022 11:16:01 +1100 Subject: [PATCH] Updating docs --- pkg/yqlib/doc/operators/array-to-map.md | 2 +- pkg/yqlib/doc/operators/headers/array-to-map.md | 2 +- pkg/yqlib/doc/operators/headers/slice-array.md | 2 +- pkg/yqlib/doc/operators/slice-array.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/pkg/yqlib/doc/operators/array-to-map.md b/pkg/yqlib/doc/operators/array-to-map.md index be9c0a6b..5930aaac 100644 --- a/pkg/yqlib/doc/operators/array-to-map.md +++ b/pkg/yqlib/doc/operators/array-to-map.md @@ -1,6 +1,6 @@ # Array to Map -Use this operator to convert an array to..a map. Skips over null values. +Use this operator to convert an array to..a map. The indices are used as map keys, null values in the array are skipped over. Behind the scenes, this is implemented using reduce: diff --git a/pkg/yqlib/doc/operators/headers/array-to-map.md b/pkg/yqlib/doc/operators/headers/array-to-map.md index 6da537b3..0e431a61 100644 --- a/pkg/yqlib/doc/operators/headers/array-to-map.md +++ b/pkg/yqlib/doc/operators/headers/array-to-map.md @@ -1,6 +1,6 @@ # Array to Map -Use this operator to convert an array to..a map. Skips over null values. +Use this operator to convert an array to..a map. The indices are used as map keys, null values in the array are skipped over. Behind the scenes, this is implemented using reduce: diff --git a/pkg/yqlib/doc/operators/headers/slice-array.md b/pkg/yqlib/doc/operators/headers/slice-array.md index 5676fd93..7f2487c8 100644 --- a/pkg/yqlib/doc/operators/headers/slice-array.md +++ b/pkg/yqlib/doc/operators/headers/slice-array.md @@ -1,4 +1,4 @@ -# Slice Array +# Slice/Splice Array The slice array operator takes an array as input and returns a subarray. Like the `jq` equivalent, `.[10:15]` will return an array of length 5, starting from index 10 inclusive, up to index 15 exclusive. Negative numbers count backwards from the end of the array. diff --git a/pkg/yqlib/doc/operators/slice-array.md b/pkg/yqlib/doc/operators/slice-array.md index 29d0dafe..40ebea49 100644 --- a/pkg/yqlib/doc/operators/slice-array.md +++ b/pkg/yqlib/doc/operators/slice-array.md @@ -1,4 +1,4 @@ -# Slice Array +# Slice/Splice Array The slice array operator takes an array as input and returns a subarray. Like the `jq` equivalent, `.[10:15]` will return an array of length 5, starting from index 10 inclusive, up to index 15 exclusive. Negative numbers count backwards from the end of the array.