From b5b8da0a1d2738a54add68a1fbb70b0fe428ad3e Mon Sep 17 00:00:00 2001 From: Mike Farah Date: Thu, 29 Apr 2021 13:18:57 +1000 Subject: [PATCH] Updating comment docs --- pkg/yqlib/doc/Comment Operators.md | 2 +- pkg/yqlib/operator_comments_test.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pkg/yqlib/doc/Comment Operators.md b/pkg/yqlib/doc/Comment Operators.md index 5a847d88..f36b48d5 100644 --- a/pkg/yqlib/doc/Comment Operators.md +++ b/pkg/yqlib/doc/Comment Operators.md @@ -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: diff --git a/pkg/yqlib/operator_comments_test.go b/pkg/yqlib/operator_comments_test.go index d88b1fb5..e137fe2b 100644 --- a/pkg/yqlib/operator_comments_test.go +++ b/pkg/yqlib/operator_comments_test.go @@ -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=""`,