Add example to FileTests doc

carvel-dev · Sep 17, 2022 · cecc394 · cecc394
1 parent d267887
commit cecc394
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/test/filetests/filetests.go b/test/filetests/filetests.go
@@ -40,6 +40,17 @@ type EvaluateTemplate func(src string) (MarshalableResult, *TestErr)
 // - expected output starting with `ERR:` indicate that expected output is an error message
 // - expected output starting with `OUTPUT POSITION:` indicate that expected output is "pos" format
 // - otherwise expected output is the literal output from template
+//
+// For example:
+//
+//	#! my-test.tpltest
+//	---
+//	#@ msg = "hello"
+//	msg: #@ msg
+//	+++
+//
+//	msg: hello
+//
 type FileTests struct {
 	PathToTests      string
 	EvalFunc         EvaluateTemplate