Skip to content

pkg/sdk/query: improve query APIs's comments #135

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

Merged
merged 1 commit into from
Apr 2, 2018
Merged

pkg/sdk/query: improve query APIs's comments #135

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
6 changes: 3 additions & 3 deletions pkg/sdk/query/query.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ import (
"github.com/coreos/operator-sdk/pkg/util/k8sutil"
)

// Get gets the kubernetes object and then unmarshals the retrieved data into the "into" object.
// Get gets the specified object and unmarshals the retrieved data into the "into" object.
// "into" is a sdkTypes.Object that must have
// "Kind" and "APIVersion" specified in its "TypeMeta" field
// and "Name" and "Namespace" specified in its "ObjectMeta" field.
// Those fields are used to construct the underlying resource client.
// "opts" configures the Get operation.
// When passed With WithGetOptions(o), the specified metav1.GetOptions is set.
func Get(into sdkTypes.Object, opts ...GetOption) error {
name, namespace, err := k8sutil.GetNameAndNamespace(into)
if err != nil {
Expand Down Expand Up @@ -55,8 +55,8 @@ func Get(into sdkTypes.Object, opts ...GetOption) error {
// "namespace" indicates which kubernetes namespace to look for the list of kubernetes objects.
// "into" is a sdkType.Object that must have
// "Kind" and "APIVersion" specified in its "TypeMeta" field
// Those are used to construct the underlying resource client.
// "opts" configures the List operation.
// When passed With WithListOptions(o), the specified metav1.ListOptions is set.
func List(namespace string, into sdkTypes.Object, opts ...ListOption) error {
gvk := into.GetObjectKind().GroupVersionKind()
apiVersion, kind := gvk.ToAPIVersionAndKind()
Expand Down