Skip to content

docs(client): document non-nil Config requirement for ContainerCreate #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
xHozey wants to merge 1 commit into from
Closed

docs(client): document non-nil Config requirement for ContainerCreate #123

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions client/client.container.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ import (
)

// ContainerCreate creates a new container.
//
// Note: options.Config must not be nil. The SDK assumes a valid container
// configuration and does not perform nil checks.
func (c *sdkClient) ContainerCreate(ctx context.Context, options client.ContainerCreateOptions) (client.ContainerCreateResult, error) {
// Add the labels that identify this as a container created by the SDK.
AddSDKLabels(options.Config.Labels)
Expand Down
Loading