docs(client): document non-nil Config requirement for ContainerCreate #123
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation to the ContainerCreate function in the Go SDK to clarify that the options.Config parameter must not be nil, as passing a nil value currently causes a panic when the function attempts to access options.Config.Labels.
Changes:
- Added doc comment to
ContainerCreatewarning thatoptions.Configmust not be nil
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mdelapenya
reviewed
Feb 6, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds documentation to
ContainerCreatein the Go SDK to clarify thatoptions.Configmust not be nil, as passing nil currently causes a panic.Why is it important?
This helps new users understand the expected invariant and prevents confusion when using
ContainerCreate. It documents a real footgun without changing runtime behavior.Related issues
How to test this PR