Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/modules/aerospike.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/arangodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/dind.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/etcd.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/pinecone.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/scylladb.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/socat.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion modulegen/_template/module.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion modulegen/main_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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, "<!--/codeinclude-->", 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])
}
Expand Down
Loading