Merge pull request #2017 from matteoolivi/add_comment_on_struct_point…

…er_to_create 📖 Advertise struct pointer requirement for Create
kubernetes-sigs · Oct 7, 2022 · 8ad090e · 8ad090e
2 parents 7399a3a + 371f601
commit 8ad090e
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/pkg/client/interfaces.go b/pkg/client/interfaces.go
@@ -60,7 +60,8 @@ type Reader interface {
 
 // Writer knows how to create, delete, and update Kubernetes objects.
 type Writer interface {
-	// Create saves the object obj in the Kubernetes cluster.
+	// Create saves the object obj in the Kubernetes cluster. obj must be a
+	// struct pointer so that obj can be updated with the content returned by the Server.
 	Create(ctx context.Context, obj Object, opts ...CreateOption) error
 
 	// Delete deletes the given obj from Kubernetes cluster.