From dac9524a80e0cda23021364dcac6d040f9f17bc7 Mon Sep 17 00:00:00 2001 From: neuroevolutus <19356702+neuroevolutus@users.noreply.github.com> Date: Sat, 11 Mar 2023 20:09:27 -0600 Subject: [PATCH] Reword explanation of relative update for comment operators --- pkg/yqlib/doc/operators/comment-operators.md | 2 +- pkg/yqlib/doc/operators/headers/comment-operators.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pkg/yqlib/doc/operators/comment-operators.md b/pkg/yqlib/doc/operators/comment-operators.md index 5f2c4ff9..89af3b1b 100644 --- a/pkg/yqlib/doc/operators/comment-operators.md +++ b/pkg/yqlib/doc/operators/comment-operators.md @@ -8,7 +8,7 @@ Like the `=` and `|=` assign operators, the same syntax applies when updating co This will set the LHS nodes' comments equal to the expression on the RHS. The RHS is run against the matching nodes in the pipeline ### relative form: `|=` -Similar to the plain form, however the RHS evaluates against each matching LHS node! This is useful if you want to set the comments as a relative expression of the node, for instance its value or path. +This is similar to the plain form, but it evaluates the RHS with _each matching LHS node as context_. This is useful if you want to set the comments as a relative expression of the node, for instance its value or path. ## Set line comment Set the comment on the key node for more reliability (see below). diff --git a/pkg/yqlib/doc/operators/headers/comment-operators.md b/pkg/yqlib/doc/operators/headers/comment-operators.md index a5de8883..262940e4 100644 --- a/pkg/yqlib/doc/operators/headers/comment-operators.md +++ b/pkg/yqlib/doc/operators/headers/comment-operators.md @@ -8,4 +8,4 @@ Like the `=` and `|=` assign operators, the same syntax applies when updating co This will set the LHS nodes' comments equal to the expression on the RHS. The RHS is run against the matching nodes in the pipeline ### relative form: `|=` -Similar to the plain form, however the RHS evaluates against each matching LHS node! This is useful if you want to set the comments as a relative expression of the node, for instance its value or path. +This is similar to the plain form, but it evaluates the RHS with _each matching LHS node as context_. This is useful if you want to set the comments as a relative expression of the node, for instance its value or path.