diff --git a/pkg/yqlib/doc/operators/comment-operators.md b/pkg/yqlib/doc/operators/comment-operators.md index 3ba9e65c..5f2c4ff9 100644 --- a/pkg/yqlib/doc/operators/comment-operators.md +++ b/pkg/yqlib/doc/operators/comment-operators.md @@ -5,7 +5,7 @@ Use these comment operators to set or retrieve comments. Note that line comments Like the `=` and `|=` assign operators, the same syntax applies when updating comments: ### plain form: `=` -This will assign the LHS nodes comments to the expression on the RHS. The RHS is run against the matching nodes in the pipeline +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. diff --git a/pkg/yqlib/doc/operators/headers/comment-operators.md b/pkg/yqlib/doc/operators/headers/comment-operators.md index d7a19d2c..a5de8883 100644 --- a/pkg/yqlib/doc/operators/headers/comment-operators.md +++ b/pkg/yqlib/doc/operators/headers/comment-operators.md @@ -5,7 +5,7 @@ Use these comment operators to set or retrieve comments. Note that line comments Like the `=` and `|=` assign operators, the same syntax applies when updating comments: ### plain form: `=` -This will assign the LHS nodes comments to the expression on the RHS. The RHS is run against the matching nodes in the pipeline +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.