diff --git a/docs/modules/aerospike.md b/docs/modules/aerospike.md index e88f6efb29..1b2882580b 100644 --- a/docs/modules/aerospike.md +++ b/docs/modules/aerospike.md @@ -29,7 +29,7 @@ go get github.com/testcontainers/testcontainers-go/modules/aerospike The Aerospike module exposes one entrypoint function to create the Aerospike container, and this function receives three parameters: ```golang -func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*AerospikeContainer, error) +func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error) ``` - `context.Context`, the Go context. diff --git a/docs/modules/arangodb.md b/docs/modules/arangodb.md index be55b6ec7b..8cc7ac4184 100644 --- a/docs/modules/arangodb.md +++ b/docs/modules/arangodb.md @@ -29,7 +29,7 @@ go get github.com/testcontainers/testcontainers-go/modules/arangodb The ArangoDB module exposes one entrypoint function to create the ArangoDB container, and this function receives three parameters: ```golang -func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*ArangoDBContainer, error) +func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error) ``` - `context.Context`, the Go context. diff --git a/docs/modules/azure.md b/docs/modules/azure.md index 26a20768ba..4bb365ac18 100644 --- a/docs/modules/azure.md +++ b/docs/modules/azure.md @@ -37,7 +37,7 @@ The Azure module exposes the following Go packages: The Azurite module exposes one entrypoint function to create the Azurite container, and this function receives three parameters: ```golang -func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*AzuriteContainer, error) +func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error) ``` - `context.Context`, the Go context. diff --git a/docs/modules/dind.md b/docs/modules/dind.md index 4a218cafb0..74f3504876 100644 --- a/docs/modules/dind.md +++ b/docs/modules/dind.md @@ -29,7 +29,7 @@ go get github.com/testcontainers/testcontainers-go/modules/dind The DinD module exposes one entrypoint function to create the DinD container, and this function receives three parameters: ```golang -func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*DinDContainer, error) +func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error) ``` - `context.Context`, the Go context. diff --git a/docs/modules/etcd.md b/docs/modules/etcd.md index aaac6012e5..1ba28ef32c 100644 --- a/docs/modules/etcd.md +++ b/docs/modules/etcd.md @@ -29,7 +29,7 @@ go get github.com/testcontainers/testcontainers-go/modules/etcd The etcd module exposes one entrypoint function to create the etcd container, and this function receives three parameters: ```golang -func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*etcdContainer, error) +func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*EtcdContainer, error) ``` - `context.Context`, the Go context. diff --git a/docs/modules/pinecone.md b/docs/modules/pinecone.md index 78caf88cd1..7c72d90443 100644 --- a/docs/modules/pinecone.md +++ b/docs/modules/pinecone.md @@ -32,7 +32,7 @@ go get github.com/testcontainers/testcontainers-go/modules/pinecone The Pinecone module exposes one entrypoint function to create the Pinecone container, and this function receives three parameters: ```golang -func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*PineconeContainer, error) +func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error) ``` - `context.Context`, the Go context. diff --git a/docs/modules/scylladb.md b/docs/modules/scylladb.md index 4382185af4..aa53cb3274 100644 --- a/docs/modules/scylladb.md +++ b/docs/modules/scylladb.md @@ -30,7 +30,7 @@ go get github.com/testcontainers/testcontainers-go/modules/scylladb The ScyllaDB module exposes one entrypoint function to create the ScyllaDB container, and this function receives three parameters: ```golang -func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*ScyllaDBContainer, error) +func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error) ``` - `context.Context`, the Go context. diff --git a/docs/modules/socat.md b/docs/modules/socat.md index ac97f88773..2a9cfa26a9 100644 --- a/docs/modules/socat.md +++ b/docs/modules/socat.md @@ -34,7 +34,7 @@ go get github.com/testcontainers/testcontainers-go/modules/socat The Socat module exposes one entrypoint function to create the Socat container, and this function receives three parameters: ```golang -func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*SocatContainer, error) +func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error) ``` - `context.Context`, the Go context. diff --git a/modulegen/_template/module.md.tmpl b/modulegen/_template/module.md.tmpl index d842f36876..73cd84090d 100644 --- a/modulegen/_template/module.md.tmpl +++ b/modulegen/_template/module.md.tmpl @@ -29,7 +29,7 @@ go get github.com/testcontainers/testcontainers-go/{{ ParentDir }}/{{ $lower }} The {{ $title }} module exposes one entrypoint function to create the {{ $title }} container, and this function receives three parameters: ```golang -func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*{{ $title }}Container, error) +func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error) ``` - `context.Context`, the Go context. diff --git a/modulegen/main_test.go b/modulegen/main_test.go index 47a828c9bd..87e2b36a68 100644 --- a/modulegen/main_test.go +++ b/modulegen/main_test.go @@ -372,7 +372,7 @@ func assertModuleDocContent(t *testing.T, module context.TestcontainersModule, m require.Equal(t, "[Creating a "+title+" container](../../"+module.ParentDir()+"/"+lower+"/examples_test.go) inside_block:Example"+entrypoint, data[19]) require.Equal(t, "", data[20]) require.Equal(t, "The "+title+" module exposes one entrypoint function to create the "+title+" container, and this function receives three parameters:", data[28]) - require.True(t, strings.HasSuffix(data[31], "(*"+title+"Container, error)")) + require.True(t, strings.HasSuffix(data[31], "(*Container, error)")) require.Equal(t, "Use the second argument in the `Run` function to set a valid Docker image.", data[44]) require.Equal(t, "In example: `Run(context.Background(), \""+module.Image+"\")`.", data[45]) }