Updating comment op doc

2026-09-01 14:14:52 +08:00 · 2021-11-14 11:10:43 +11:00
parent 832db92eb2
commit 3cdbfebe46
1 changed files with 22 additions and 0 deletions
@@ -139,6 +139,26 @@ will output
 welcome!
 ```

+## 
+Given a sample.yml file of:
+```yaml
+# welcome!
+---
+# bob
+a: cat # meow
+
+# have a great day
+```
+then
+```bash
+yq eval 'headComment' sample.yml
+```
+will output
+```yaml
+welcome!
+bob
+```
+
 ## Get foot comment
 Given a sample.yml file of:
 ```yaml
@@ -147,6 +167,7 @@ Given a sample.yml file of:
 a: cat # meow

 # have a great day
+# no really
 ```
 then
 ```bash
@@ -155,5 +176,6 @@ yq eval '. | footComment' sample.yml
 will output
 ```yaml
 have a great day
+no really
 ```