suyiiyii/yq
1
0
Fork 0
mirror of https://github.com/mikefarah/yq.git synced 2025-01-23 14:16:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating comment docs

Browse Source
This commit is contained in:
Mike Farah 2021-04-29 13:18:57 +10:00
parent fa21510194
commit b5b8da0a1d
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/Comment Operators.md
View File

@ -88,7 +88,7 @@ a: cat
b: dog # leave this
```
## Remove all comments
## Remove (strip) all comments
Note the use of `...` to ensure key nodes are included.
Given a sample.yml file of:

2
pkg/yqlib/operator_comments_test.go
View File

@ -71,7 +71,7 @@ var commentOperatorScenarios = []expressionScenario{
},
},
{
description: "Remove all comments",
description: "Remove (strip) all comments",
subdescription: "Note the use of `...` to ensure key nodes are included.",
document: "# hi\n\na: cat # comment\n\n# great\n\nb: # key comment",
expression: `... comments=""`,