suyiiyii/yq
1
0
Fork 0
mirror of https://github.com/mikefarah/yq.git synced 2026-07-10 16:55:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Reword explanation of relative update for comment operators

Browse Source
This commit is contained in:
neuroevolutus 2023-03-11 20:09:27 -06:00
parent 1302fe75f6
commit dac9524a80
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pkg/yqlib/doc/operators/comment-operators.md
View File

@ -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 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: `|=` ### 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 line comment
Set the comment on the key node for more reliability (see below). Set the comment on the key node for more reliability (see below).

2
pkg/yqlib/doc/operators/headers/comment-operators.md
View File

@ -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 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: `|=` ### 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.