Skip to content

Commit

Permalink
Merge pull request #1818 from sgreene570/fix-option-godocs
Browse files Browse the repository at this point in the history
✨ manager.go: Fix a few Options fields' go-docs
  • Loading branch information
k8s-ci-robot committed Mar 1, 2022
2 parents d887b2f + 364ed9a commit eb292e5
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions pkg/manager/manager.go
Expand Up @@ -98,9 +98,9 @@ type Manager interface {

// Options are the arguments for creating a new Manager.
type Options struct {
// Scheme is the scheme used to resolve runtime.Objects to GroupVersionKinds / Resources
// Scheme is the scheme used to resolve runtime.Objects to GroupVersionKinds / Resources.
// Defaults to the kubernetes/client-go scheme.Scheme, but it's almost always better
// idea to pass your own scheme in. See the documentation in pkg/scheme for more information.
// to pass your own scheme in. See the documentation in pkg/scheme for more information.
Scheme *runtime.Scheme

// MapperProvider provides the rest mapper used to map go types to Kubernetes APIs
Expand Down Expand Up @@ -186,11 +186,11 @@ type Options struct {
// between tries of actions. Default is 2 seconds.
RetryPeriod *time.Duration

// Namespace if specified restricts the manager's cache to watch objects in
// the desired namespace Defaults to all namespaces
// Namespace, if specified, restricts the manager's cache to watch objects in
// the desired namespace. Defaults to all namespaces.
//
// Note: If a namespace is specified, controllers can still Watch for a
// cluster-scoped resource (e.g Node). For namespaced resources the cache
// cluster-scoped resource (e.g Node). For namespaced resources, the cache
// will only hold objects from the desired namespace.
Namespace string

Expand Down Expand Up @@ -228,7 +228,7 @@ type Options struct {
// if this is set, the Manager will use this server instead.
WebhookServer *webhook.Server

// Functions to all for a user to customize the values that will be injected.
// Functions to allow for a user to customize values that will be injected.

// NewCache is the function that will create the cache to be used
// by the manager. If not set this will use the default new cache function.
Expand Down

0 comments on commit eb292e5

Please sign in to comment.