Add exported function description

crossplane · Nov 29, 2023 · 1f75c6f · 1f75c6f
1 parent c40331d
commit 1f75c6f
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/pkg/terraform/files.go b/pkg/terraform/files.go
@@ -130,6 +130,8 @@ type FileProducer struct {
 	features    *feature.Flags
 }
 
+// BuildMainTF produces the contents of the mainTF file as a map.  This format is conducive to
+// inspection for tests.  WriteMainTF calls this function an serializes the result to a file as JSON.
 func (fp *FileProducer) BuildMainTF() map[string]any {
 	// If the resource is in a deletion process, we need to remove the deletion
 	// protection.