chore: add comments to functions

mdelapenya · Nov 9, 2022 · e07d6c6 · e07d6c6
1 parent fead327
commit e07d6c6
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/examples/_template/example.go.tmpl b/examples/_template/example.go.tmpl
@@ -6,10 +6,12 @@ import (
 	"github.com/testcontainers/testcontainers-go"
 )
 
+// {{ $lower }}Container represents the {{ .Name }} container type used in the module
 type {{ $lower }}Container struct {
 	testcontainers.Container
 }
 
+// setup{{ $title }} creates an instance of the {{ .Name }} container type
 func setup{{ $title }}(ctx context.Context) (*{{ $lower }}Container, error) {
 	req := testcontainers.ContainerRequest{
 		Image: "{{ .Image }}",

diff --git a/examples/main_test.go b/examples/main_test.go
@@ -91,10 +91,12 @@ func assertExampleContent(t *testing.T, exampleName string, exampleImage string,
 
 	data := strings.Split(string(content), "\n")
 	assert.Equal(t, data[0], "package "+lower)
-	assert.Equal(t, data[8], "type "+lower+"Container struct {")
-	assert.Equal(t, data[12], "func setup"+title+"(ctx context.Context) (*"+lower+"Container, error) {")
-	assert.Equal(t, data[14], "\t\tImage: \""+exampleImage+"\",")
-	assert.Equal(t, data[24], "\treturn &"+lower+"Container{Container: container}, nil")
+	assert.Equal(t, data[8], "// "+lower+"Container represents the "+exampleName+" container type used in the module")
+	assert.Equal(t, data[9], "type "+lower+"Container struct {")
+	assert.Equal(t, data[13], "// setup"+title+" creates an instance of the "+exampleName+" container type")
+	assert.Equal(t, data[14], "func setup"+title+"(ctx context.Context) (*"+lower+"Container, error) {")
+	assert.Equal(t, data[16], "\t\tImage: \""+exampleImage+"\",")
+	assert.Equal(t, data[26], "\treturn &"+lower+"Container{Container: container}, nil")
 }
 
 // assert content go.mod