taigrr/yq
1
0
Fork 0
mirror of https://github.com/taigrr/yq synced 2025-01-18 04:53:17 -08:00
Code Issues Projects Releases Wiki Activity

Improving docs

Browse Source
This commit is contained in:
Mike Farah
2021-02-26 11:31:43 +11:00
parent b1a5387cdd
commit e93c43f7a0
7 changed files with 55 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
pkg/yqlib/doc/headers/Assign.md → pkg/yqlib/doc/headers/Assign (Assign).md
View File

12
pkg/yqlib/doc/headers/Comment Operators.md
View File

@@ -1 +1,11 @@
Use these comment operators to set or retrieve comments.
Use these comment operators to set or retrieve 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
### 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.