diff --git a/pkg/yqlib/doc/operators/headers/omit.md b/pkg/yqlib/doc/operators/headers/omit.md new file mode 100644 index 00000000..00191dde --- /dev/null +++ b/pkg/yqlib/doc/operators/headers/omit.md @@ -0,0 +1,3 @@ +# Omit + +Works like `pick`, but instead you specify the keys/indices that you _don't_ want included. diff --git a/pkg/yqlib/doc/operators/omit.md b/pkg/yqlib/doc/operators/omit.md index 273b3956..56a7f70d 100644 --- a/pkg/yqlib/doc/operators/omit.md +++ b/pkg/yqlib/doc/operators/omit.md @@ -1,6 +1,9 @@ +# Omit + +Works like `pick`, but instead you specify the keys/indices that you _don't_ want included. ## Omit keys from map -Note that the order of the keys matches the omit order and non existent keys are skipped. +Note that non existent keys are skipped. Given a sample.yml file of: ```yaml @@ -22,7 +25,7 @@ myMap: ``` ## Omit indices from array -Note that the order of the indices matches the omit order and non existent indices are skipped. +Note that non existent indices are skipped. Given a sample.yml file of: ```yaml diff --git a/pkg/yqlib/operator_omit_test.go b/pkg/yqlib/operator_omit_test.go index 5f264b61..dbd6d9c0 100644 --- a/pkg/yqlib/operator_omit_test.go +++ b/pkg/yqlib/operator_omit_test.go @@ -7,7 +7,7 @@ import ( var omitOperatorScenarios = []expressionScenario{ { description: "Omit keys from map", - subdescription: "Note that the order of the keys matches the omit order and non existent keys are skipped.", + subdescription: "Note that non existent keys are skipped.", document: "myMap: {cat: meow, dog: bark, thing: hamster, hamster: squeak}\n", expression: `.myMap |= omit(["hamster", "cat", "goat"])`, expected: []string{ @@ -34,7 +34,7 @@ var omitOperatorScenarios = []expressionScenario{ }, { description: "Omit indices from array", - subdescription: "Note that the order of the indices matches the omit order and non existent indices are skipped.", + subdescription: "Note that non existent indices are skipped.", document: `[cat, leopard, lion]`, expression: `omit([2, 0, 734, -5])`, expected: []string{