Skip to content

Commit f6d6fd2

Browse files
committed
resolve doc comments
1 parent 12a8722 commit f6d6fd2

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/features/garbage_collector.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,11 @@ The primary method is to use the `Terminate(context.Context)` function that is
1717
available when a container is created. Use `defer` to ensure that it is called
1818
on test completion.
1919

20+
The `Terminate` function can be customised with termination options to determine how a container is removed: termination timeout, and the ability to remove container volumes are supported at the moment. You can build the default options using the `testcontainers.NewTerminationOptions` function.
21+
2022
#### NewTerminateOptions
2123

22-
- Since testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.35.0"><span class="tc-version">:material-tag: v0.35.0</span></a>
24+
- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
2325

2426
If you want to attach option to container termination, you can use the `testcontainer.NewTerminateOptions(ctx context.Context, opts ...TerminateOption) *TerminateOptions` option, which receives a TerminateOption as parameter, creating custom termination options to be passed on the container termination.
2527

0 commit comments

Comments
 (0)