yq/pkg/yqlib/doc/operators/headers/comment-operators.md

12 lines
681 B
Markdown
Raw Normal View History

2021-11-03 04:00:58 +00:00
# Comment Operators
2022-09-30 00:15:41 +00:00
Use these comment operators to set or retrieve comments. Note that line comments on maps/arrays are actually set on the _key_ node as opposed to the _value_ (map/array). See below for examples.
2021-02-26 00:31:43 +00:00
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
### 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.