move docs to garbage_collector/#terminate-function

testcontainers · Jan 2, 2025 · 12a8722 · 12a8722
1 parent f4c786f
commit 12a8722
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 38 deletions.
diff --git a/docs/features/common_functional_options.md b/docs/features/common_functional_options.md
@@ -165,41 +165,3 @@ The above example is updating the predefined command of the image, **appending**
 
 !!!info
     This can't be used to replace the command, only to append options.
-
-#### NewTerminateOptions
-
-- 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>
-
-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.
-
-##### Terminate Options
-
-###### [StopContext](../../cleanup.go)
-Sets the context for the Container termination.
-
-- **Function**: `StopContext(ctx context.Context) TerminateOption`
-- **Default**: The context passed in `Terminate()`
-- **Usage**:
-```go
-err := container.Terminate(ctx,StopContext(context.Background()))
-```
-
-###### [StopTimeout](../../cleanup.go)
-Sets the timeout for stopping the Container.
-
-- **Function**: ` StopTimeout(timeout time.Duration) TerminateOption`
-- **Default**:  10 seconds
-- **Usage**:
-```go
-err := container.Terminate(ctx, StopTimeout(20 * time.Second))
-```
-
-###### [RemoveVolumes](../../cleanup.go)
-Sets the volumes to be removed during Container termination.
-
-- **Function**: ` RemoveVolumes(volumes ...string) TerminateOption`
-- **Default**:  Empty (no volumes removed)
-- **Usage**:
-```go
-err := container.Terminate(ctx, RemoveVolumes("vol1", "vol2"))
-```
diff --git a/docs/features/garbage_collector.md b/docs/features/garbage_collector.md
@@ -17,6 +17,45 @@ The primary method is to use the `Terminate(context.Context)` function that is
 available when a container is created. Use `defer` to ensure that it is called
 on test completion.
 
+#### NewTerminateOptions
+
+- 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>
+
+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.
+
+##### Terminate Options
+
+###### [StopContext](../../cleanup.go)
+Sets the context for the Container termination.
+
+- **Function**: `StopContext(ctx context.Context) TerminateOption`
+- **Default**: The context passed in `Terminate()`
+- **Usage**:
+```go
+err := container.Terminate(ctx,StopContext(context.Background()))
+```
+
+###### [StopTimeout](../../cleanup.go)
+Sets the timeout for stopping the Container.
+
+- **Function**: ` StopTimeout(timeout time.Duration) TerminateOption`
+- **Default**:  10 seconds
+- **Usage**:
+```go
+err := container.Terminate(ctx, StopTimeout(20 * time.Second))
+```
+
+###### [RemoveVolumes](../../cleanup.go)
+Sets the volumes to be removed during Container termination.
+
+- **Function**: ` RemoveVolumes(volumes ...string) TerminateOption`
+- **Default**:  Empty (no volumes removed)
+- **Usage**:
+```go
+err := container.Terminate(ctx, RemoveVolumes("vol1", "vol2"))
+```
+
+
 !!!tip
 
     Remember to `defer` as soon as possible so you won't forget. The best time